Skip to content

#5: Docs consistency pass - #4

Merged
miroslavpojer merged 2 commits into
masterfrom
docs/phase-0-step-1-consistency-pass
Sep 3, 2026
Merged

#5: Docs consistency pass#4
miroslavpojer merged 2 commits into
masterfrom
docs/phase-0-step-1-consistency-pass

Conversation

@miroslavpojer

@miroslavpojer miroslavpojer commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Overview

One consistency pass over every file in living-docREADME.md, CONTRIBUTING.md, and
everything under docs/ (introduction, guides, tutorials, projects, specs). The pages were written
across several incremental rounds and had drifted; this PR reconciles them. No behaviour changes —
documentation only.

Fixed, in order:

  1. Naming driftgenerator-ready.json is the final name for the toolkit's canonical dataset.
    All 5 tutorials, quickstart.md, getting-started.md, and the spec prose/diagrams/task lists
    still used the old pdf_ready.json / pdf_ready_json / PDFREADY. Every occurrence now reads
    generator-ready.json; the pre-rename names survive only inside a labelled "Superseded name"
    callout in docs/specs/data-flows.md §5.
  2. Python floor — example actions/setup-python snippets pinned python-version: '3.11' in 7
    files; all moved to '3.10' to match the agreed ecosystem floor.
  3. Tutorial-capture scopedocs/specs/architecture.md §4.1 and docs/specs/roadmap.md Post-v1
    are 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.
  4. Links & anchors — full relative-link + heading-anchor check over docs/** + root *.md is
    clean (0 missing files, 0 missing anchors). No §/anchor cross-reference points at a section
    absent from its target. No [[wiki-link]] syntax anywhere.
  5. Decision-driven cross-spec corrections — confirmed applied in the target specs and that no
    doc still references the superseded text: 3.10 (not 3.14) Python floor, no additive
    v1.x/v2.0.0 schema gate, datasets_pdf rename in-scope for Phase 1 (not "deferred").
  6. Self-referential tokensroadmap.md Step 1 and phase-0-tasklist.md P0-A1 literally
    contained 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):

File Change
docs/guides/getting-started.md python-version'3.10'; pdf_ready.jsongenerator-ready.json (×3); rewrote the file-names note
docs/introduction/quickstart.md python-version'3.10'; pdf_ready.jsongenerator-ready.json (×2)
docs/tutorials/gh-issues-to-markdown.md python-version'3.10'; pdf_ready.jsongenerator-ready.json (×2)
docs/tutorials/gh-source-to-markdown.md same
docs/tutorials/gh-source-to-pdf.md same
docs/tutorials/user-stories-to-pdf.md same
docs/tutorials/ado-workitems-to-markdown.md same

Acceptance criteria

  • Link check over docs/** + root *.md is clean — every relative link resolves; every anchor
    matches 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 '\[\[|\]\]' over docs/** returns nothing.
  • No cross-reference names a §/anchor absent from its target document.
  • Tutorial-capture scope wording is identical in docs/specs/architecture.md §4.1 and
    docs/specs/roadmap.md Post-v1, and consistent in the glossary.
  • No python-version: '3.1[1-4]' literal remains in docs/**.
  • This PR body carries the change report.

Release Notes

  • Documentation examples now use the final artifact name generator-ready.json for the toolkit's
    canonical dataset (previously shown as pdf_ready.json).
  • Example workflow snippets in the quickstart, Getting Started guide, and tutorials pin
    python-version: '3.10', matching the ecosystem's Python 3.10 floor.
  • Cross-references, tutorial-capture scope wording, and stray wiki-link syntax across the docs set
    were reconciled after several incremental drafting rounds.

Related

Closes #5

@miroslavpojer miroslavpojer self-assigned this Sep 3, 2026
@miroslavpojer miroslavpojer changed the title fix(tutorials): update Python version and output file names in tutorials 5: Step 1 — docs consistency pass Sep 3, 2026
@miroslavpojer miroslavpojer changed the title 5: Step 1 — docs consistency pass 5: Docs consistency pass Sep 3, 2026
@miroslavpojer miroslavpojer changed the title 5: Docs consistency pass #5: Docs consistency pass Sep 3, 2026
@miroslavpojer
miroslavpojer merged commit 8c4dd66 into master Sep 3, 2026
1 of 2 checks passed
@miroslavpojer
miroslavpojer deleted the docs/phase-0-step-1-consistency-pass branch September 3, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs consistency pass

1 participant