Skip to content

version_basis: support the intro-and-prompt-at-top layout (no guide changes) - #701

Merged
jposluns merged 3 commits into
mainfrom
tooling/intro-and-prompt-at-top
Oct 19, 2026
Merged

jposluns merged 3 commits into
mainfrom
tooling/intro-and-prompt-at-top

Conversation

@jposluns

Copy link
Copy Markdown
Owner

Tooling for the next guide layout (maintainer ruling, 2026-10-19). No guide changes in this PR; guides move one by one afterwards, once their introductions are drafted and reviewed.

  • New top of guide: the title; one introduction paragraph written for people (ordinary guide text, inside the body digest); then the line "If an AI assistant is helping you secure a deployment, give it the prompt below:" and the existing per-guide prompt (wording unchanged); then the existing versions and dates paragraphs; then the guide. An invisible anchor marks the prompt so the end note can link to it.
  • Digest: the generated block (prompt line, prompt, versions paragraphs) is excluded from the digest only when it exactly matches what the tool renders, in one of two positions: directly after the title (today's layout) or directly after exactly one introduction paragraph. Anything else fails closed. Duplicate or edited generated content is rejected.
  • End note: the "About the AI assistant section below" heading stays with a two-sentence note that links to the prompt at the top; the prompt appears once.
  • --introduce GUIDE --intro TEXT: inserts the introduction, moves the generated block below it, rewrites the end note, rebinds the digest, and checks that the guide body differs from the old body only by the inserted paragraph and that no metadata other than the digest changes.
  • Gates: Verify marking masks the generated block; the TLS-safety gate masks it only after canonical validation; bare-URL rules are unchanged; the local-link check accepts only the exact generated prompt anchor.
  • Tests: both positions, the exact-render exclusion, the anchor and link, the helper's body-difference check, and rejection of misplaced or edited blocks (111 version-basis tests). CONTRIBUTING.md describes the layout.
  • VERSION and plugin/plugin.json 1.0.701; CHANGELOG entry under 2026-10-19; generated files rebuilt (no guide content change).

Local checks run by the integrator on this head (pinned markdown-it-py 4.2.0): tools/test_version_basis.py OK; tools/run_all_checks.sh passed (All gates passed.). The worker's trial on three guides (vault.md, mongodb.md, lighttpd.md, with placeholder introductions not included here) also passed the suite.

…hanges)

Generated top block (prompt line, prompt, versions header) placed after a human intro paragraph and excluded from the digest by exact render; shortened end note with a link to the prompt; --introduce helper; gates mask the new block; existing two-section guides keep validating.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Deploying secureconfig with  Cloudflare Pages  Cloudflare Pages

Latest commit: d63a772
Status: ✅  Deploy successful!
Preview URL: https://6e0b6e84.secureconfig.pages.dev
Branch Preview URL: https://tooling-intro-and-prompt-at.secureconfig.pages.dev

View logs

@jposluns
jposluns merged commit 2662c02 into main Oct 19, 2026
2 checks passed
@jposluns
jposluns deleted the tooling/intro-and-prompt-at-top branch October 19, 2026 16:42
jposluns added a commit that referenced this pull request Oct 19, 2026
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