#5: Docs consistency pass - #4
Merged
Merged
Conversation
…ue number requirement
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
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.
Overview
One consistency pass over every file in
living-doc—README.md,CONTRIBUTING.md, andeverything under
docs/(introduction, guides, tutorials, projects, specs). The pages were writtenacross several incremental rounds and had drifted; this PR reconciles them. No behaviour changes —
documentation only.
Fixed, in order:
generator-ready.jsonis the final name for the toolkit's canonical dataset.All 5 tutorials,
quickstart.md,getting-started.md, and the spec prose/diagrams/task listsstill used the old
pdf_ready.json/pdf_ready_json/PDFREADY. Every occurrence now readsgenerator-ready.json; the pre-rename names survive only inside a labelled "Superseded name"callout in
docs/specs/data-flows.md§5.actions/setup-pythonsnippets pinnedpython-version: '3.11'in 7files; all moved to
'3.10'to match the agreed ecosystem floor.docs/specs/architecture.md§4.1 anddocs/specs/roadmap.mdPost-v1are now word-for-word identical on the narrow "run the flagged scenarios and collect
screenshots + step commentary" scope. No text anywhere implies a video-generation skill exists in
this ecosystem or in
agentic-toolkit.docs/**+ root*.mdisclean (0 missing files, 0 missing anchors). No
§/anchor cross-reference points at a sectionabsent from its target. No
[[wiki-link]]syntax anywhere.doc still references the superseded text: 3.10 (not 3.14) Python floor, no additive
v1.x/v2.0.0schema gate,datasets_pdfrename in-scope for Phase 1 (not "deferred").roadmap.mdStep 1 andphase-0-tasklist.mdP0-A1 literallycontained the strings their own acceptance greps search for (
pdf_ready,[[…]],python-version: '3.11'); reworded to preserve meaning without the literal tokens.Files touched
Tracked (in this diff):
docs/guides/getting-started.mdpython-version→'3.10';pdf_ready.json→generator-ready.json(×3); rewrote the file-names notedocs/introduction/quickstart.mdpython-version→'3.10';pdf_ready.json→generator-ready.json(×2)docs/tutorials/gh-issues-to-markdown.mdpython-version→'3.10';pdf_ready.json→generator-ready.json(×2)docs/tutorials/gh-source-to-markdown.mddocs/tutorials/gh-source-to-pdf.mddocs/tutorials/user-stories-to-pdf.mddocs/tutorials/ado-workitems-to-markdown.mdAcceptance criteria
docs/**+ root*.mdis clean — every relative link resolves; every anchormatches an existing heading.
grep -riE 'pdf[_-]ready|doc[_-]ready'returns hits only inside the labelled "superseded name"callout in
docs/specs/data-flows.md§5.grep -rE '\[\[|\]\]'overdocs/**returns nothing.§/anchor absent from its target document.docs/specs/architecture.md§4.1 anddocs/specs/roadmap.mdPost-v1, and consistent in the glossary.python-version: '3.1[1-4]'literal remains indocs/**.Release Notes
generator-ready.jsonfor the toolkit'scanonical dataset (previously shown as
pdf_ready.json).python-version: '3.10', matching the ecosystem's Python 3.10 floor.were reconciled after several incremental drafting rounds.
Related
Closes #5