docs: worked-example walkthrough + pdca.dev publishing machinery - #51
Merged
Conversation
…inery Two additions, both at the repo root (sibling to template/): - docs/ — a step-by-step walkthrough that drives one real contribution through every beat of the cycle (00 introduction → 07 publish & act), anchored in the live gramps-testbed-v2 instance. Root README now points to it. - docs/publishing/ — a static-site generator (render_site.py + lint_docs.py, HTML templates, style.css) that renders the guide + the vendored quality-cycle model into the pdca.dev site, plus GitHub Actions to publish (docs.yml → eduralph/pdca.dev) and check on PRs (docs-check.yml). Adapted from the wyrd docs pipeline. Site map: / (landing from docs/index.yml), /guide/ (00–07), /spec/ (the quality-cycle model). Build verified: 22 pages, link audit clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…e model-agnostic The cycle model mandates no vendor — leaves are arbitrary pdca.toml commands and the reviewer defaults cross-vendor (Codex). Drop the 'driven by Claude' footer and the prerequisite framing that read Claude as required. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Closes #49.
Adds, at the repo root (sibling to
template/):docs/— a worked-example walkthrough. Drives one real contribution through every beat of the PDCA cycle, anchored in the live gramps-testbed-v2 instance (real brief, patch, gate table, §6 checklist, a two-iteration sign-off, and an Act entry). Sequenced 00 Introduction → 07 Publish & Act. The root README now points to it.docs/publishing/— the pdca.dev publishing machinery (adapted from the wyrd docs pipeline):tools/render_site.py— renders the guide + the vendoredtemplate/PCDA/quality-cycle/model into a static site; rewrites relative links (published → site URL; other repo files → GitHub URL);--checkaudits internal links.tools/lint_docs.py— guards against Obsidian[[wikilinks]].templates/page.html+home.html,site/{assets/style.css,CNAME,.nojekyll},index.yml(landing content)..github/workflows/docs.yml— push-to-main: lint → render → deploy toeduralph/pdca.dev(CNAME pdca.dev)..github/workflows/docs-check.yml— PR-time lint +render --check, no deploy.Site map:
/(landing),/guide/(00–07),/spec/(quality-cycle model 00–10).Verification
render_site.py --check→ 22 pages, link audit OK.lint_docs.py→ OK.eduralph/pdca.devmain.Follow-up (repo settings, not in this PR)
DOCS_DEPLOY_KEY(write-enabled deploy key oneduralph/pdca.dev) sodocs.ymlcan publish on future pushes.pdca.devPages (deploy frommain/root) + DNS.🤖 Generated with Claude Code