Skip to content

fix(docs-pipeline): make it run from a fresh clone and remove private setup - #30

Merged
darthrootbeer merged 6 commits into
mainfrom
fix/docs-pipeline-runnable
Oct 2, 2026
Merged

darthrootbeer merged 6 commits into
mainfrom
fix/docs-pipeline-runnable

Conversation

@darthrootbeer

Copy link
Copy Markdown
Owner

Context

An independent cold review found that the docs-pipeline, the first example in this repo, stopped on a fresh clone: stage 3b and stage 4c looked for knowledge files that were not shipped, stage 0 needed a private tooling repo, and there was no way to install the skills. Its style guides also read like they came from a payments company. This fixes findings H1, H2, H3 and M7 and the low findings that touch the docs-pipeline or the readability skill. Ticket: JBSR-099.

Changes

  • Knowledge files (H1). Adds the seven product knowledge starters (index, integration types, endpoints, domain models, error codes, webhooks, recent changes), each with fill-in instructions and a few fictional example rows. Every skill, the README, SETUP and ARCHITECTURE now point at one style guide path, _knowledge/style-guides/general/style-guide_general.md, and the other style passes read from ./_knowledge/ too.
  • Private setup removed (H2). Stage 0 no longer touches a private repo or .cursor links. It copies _knowledge/ into each workspace, ships its own workspace-gitignore.template, and treats {SHARED_CONFIG_DIR} and {NOTES_DIR} as optional: unset means the step is skipped. The audit's optional schema and diagram tool follow the same rule, and the docs repo steps in stage 4c skip with a note instead of stopping. The personal-habit line is now a neutral sentence.
  • Install and smoke test (H3). SETUP gains an exact install loop (one SKILL.md folder per skill, 17 in all, with the pipeline path filled in), a way to check they registered, and a smoke test on a new sample doc, sample/acme-orders-cancellations.md. The leftover Downloads grep is fixed.
  • Neutral examples (M7). Every payments-company example in the style guides and skills is now a made-up 'Acme Orders API' with orders, customers and invoices. Every rule and the structure are unchanged.
  • Lower findings. A README for skills/docs-readability-check with a prompt block (L5), unrendered template links wrapped (L7), a reserved example domain (L8), saved prompt run records (L11), and the 'Understand and teach' prompt now asks what the person does between stages (L12).
  • Tests and proof. tests/check_pipeline.py is an offline check (26 problems on the old main, none now). tests/smoke-test-run.md holds real output from a fresh clone: install, stage 0, stage 3b and stage 4c, plus stages 1, 3c, 3d and 3e. Prompts were re-run on Sonnet and Haiku, with the answers in tests/prompt-runs/.
  • Scope. Only pipelines/docs-pipeline/ and skills/docs-readability-check/. Nothing else changed.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XV3Ggh86cf2xwUyz28XaN6

  • Docs updated

darthrootbeer and others added 6 commits October 1, 2026 22:21
…lity skill readme

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XV3Ggh86cf2xwUyz28XaN6
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XV3Ggh86cf2xwUyz28XaN6
@darthrootbeer
darthrootbeer merged commit cefd3d4 into main Oct 2, 2026
6 checks passed
@darthrootbeer
darthrootbeer deleted the fix/docs-pipeline-runnable branch October 2, 2026 02:46
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.

1 participant