feat(adoption): maintain-demo --pdf + docs/ADOPTION.md with real results#94
Merged
Conversation
…s/ADOPTION.md with real results Completes the adoption/marketing tier: the maintain story is now shareable in every format a team needs (interactive page / markdown / PDF), and there's a field guide for adopting it with REAL, verifiable results. - pdf-lite.ts (PURE, dependency-free): a minimal PDF 1.4 writer — base-14 fonts (Helvetica/Bold/Courier), A4, word-wrap + auto-pagination, uncompressed streams (so tests can grep the text), unicode→Latin-1 sanitizer for emoji/dashes/arrows. Tests re-verify every xref byte offset points at its object header. ~4KB output, `file` identifies it as valid PDF. - maintain-demo: buildMaintainDemoPdfBlocks() from the SAME SCOPES/STEPS as the HTML/MD demo (single source of truth); `qodex maintain-demo --pdf [-o file]`. - docs/ADOPTION.md: 10-minute setup, a 7-rung rollout ladder (--dry-run → consolidate-dupes), and a case study of REAL merged runs on this repo — PR #62 (6 unused imports removed, verified) and PR #64 (4 consts removed, 6 BLOCKED by the side-effect gate — blocked runs are the product working), plus the real find_similar_helpers cluster. Team/audit section (maintain-audit --sign, CI verify) + FAQ. Linked from README + MAINTAIN.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P3 — the adoption tier, completing the roadmap.
1.
qodex maintain-demo --pdf— a dependency-free one-pagerpdf-lite.ts(PURE): a minimal PDF 1.4 writer with zero dependencies — base-14 fonts (Helvetica/Bold/Courier), A4, word-wrap + auto-pagination, and a unicode→Latin-1 sanitizer (✅→[OK], —→-, →→->) so base fonts can render the demo content. Streams are deliberately uncompressed so tests can grep the text.N 0 objheader — the part of PDF generation that silently breaks.buildMaintainDemoPdfBlocks()derives from the sameSCOPES/STEPSas the interactive page and the markdown export — three formats, one source of truth.fileidentifies it asPDF document, version 1.4, 1 pages.2.
docs/ADOPTION.md— the field guide, with REAL resultsNo fabricated benchmarks — the case study is this very repository, with clickable merged PRs:
unused-imports: 6 removed, tsc + suite green, verified PRunused-locals: 4 removed, 6 BLOCKED by the side-effect gate — framed as the key lesson: blocked runs are the product working--dry-runinventory (37 symbols) and the realfind_similar_helpers4-copywalkSourceclusterPlus: 10-minute setup, a 7-rung rollout ladder (
--dry-run→unused-imports→ … →consolidate-dupes), monorepo focus paths, the team audit-trail section (maintain-audit --sign+ CI verify), and an honest FAQ (no tests → dep-bump blocks; merging is always yours). Linked from README and MAINTAIN.md.+8 pdf-lite tests. Full suite 1508 green, tsc clean.