Skip to content

[kb-docs] docs: document knowledge-base v1.3.1 - #10

Draft
github-actions[bot] wants to merge 1 commit into
masterfrom
docs/sync-kb-v1.3.1-29270ec0f4f0898d
Draft

github-actions[bot] wants to merge 1 commit into
masterfrom
docs/sync-kb-v1.3.1-29270ec0f4f0898d

Conversation

@github-actions

Copy link
Copy Markdown

Caution

Protected files were modified in this change.
This pull request is in request-review mode and requires explicit human scrutiny before merge.

Protected files: .kb-sync/features.yml

Allow intentional protected-file changes

If this workflow is intended to modify these files, add specific filenames or folder prefixes to safe-outputs.create-pull-request.protected-files.exclude in the workflow Markdown frontmatter. For example, to allow .changeset/*, exclude the folder using .changeset/:

safe-outputs:
  create-pull-request:
    protected-files:
      policy: request-review
      exclude:
        - .changeset/

Keep your existing policy and exclusions. Folder exclusions use path prefixes, not glob patterns, and allow all files beneath that folder, including subfolders. Other protected files still require review. If allowed-files is configured, these paths must also match it. Run gh aw compile after updating the workflow.

Mode and range

full — initial sync → v1.3.1 (f95eb35b47051b66fb0154319780aefe4431ba17, 2026-11-06).

Features

Feature Change Page
overview, portal-ui, html-rehosting added docs/index.md, docs/kb/how-it-works.md
onboarding-choice, iframe entries added docs/kb/onboarding.md
single-page onboarding + rendering/sanitiser added docs/kb/single-page.md
packaged onboarding, headless rules added docs/kb/packaged.md
manifest, archive, size limits added docs/kb/manifest.md
rules (all 18 IDs), checker CLI added docs/kb/rules.md
publish-docs, check-docs, publish-single-page-docs, versioning added docs/kb/actions.md
style tokens added docs/kb/style-tokens.md
kb-docs-add skill added docs/kb/agent-skill.md
registry (sources, options, iframe, KB_REGISTRY) added docs/kb/registry.md
build modes, strict, kb-build.json added docs/kb/building.md
deployment repo, build-image.yml, rollback added docs/kb/deployment.md
docker/nginx routes, caching, CSP added docs/kb/docker-nginx.md
private networks added docs/kb/private-networks.md
web fragment embedding added docs/kb/embedding.md
changelog added docs/kb/changelog.md
landing page rewritten around the Knowledge Base data/showcase.yml

.kb-sync/features.yml synced set to v1.3.1; kb-docs.json pages regenerated by the build. python scripts/pack.py --headless succeeds with no warnings. The Docs Template pages were not touched.

Upstream disagreements (prose vs code)

  • contract/STYLE_GUIDE.md tells authors to load Inter from Google Fonts, but contract/RULES.md (KB-CSP-001) and nginx.headers.conf block third-party fonts and styles. Documented as: bundle the font.
  • contract/DEPLOYMENT.md lists the headline kb-build.json example without the headless and iframes fields that scripts/build-vite.js (writeProvenance) writes. The guide documents what the code writes.
  • contract/RULES.md and contract/ARTIFACT.md say an unknown icon falls back to book-open; contract/kb-docs.schema.json makes icon an enum, so schema validation (KB-MAN-001) rejects it first. src/utils/registry.js is the only place the fallback applies.
  • contract/DEPLOYMENT.md says the Knowledge Base build needs Node 24; the actions run on Node 20 (actions/*/action.yml). Both are documented separately.

Changes needed outside my area

  • .github/workflows/pack.yml is unchanged and still valid for v1.3.1.
  • docs/index.md.new is a stray scratch file I created and could not delete because rm was denied in the sandbox; it is not committed. Please ignore it.

Release Notes

  • New Knowledge Base user guide sections: Knowledge Base, Publish Your Docs, Run a Knowledge Base, Embed in a Host App and Reference.
  • Documents the three onboarding types, the manifest and archive rules, every contract rule ID with fixes, the three GitHub Actions with inputs and outputs, the build, strict mode, deployment workflow, nginx image, private-network inputs and web-fragment embedding.
  • Landing page now presents the Knowledge Base, with the Docs Template as one feature.
  • Changelog entry for v1.3.1.

Generated by Keep the Knowledge Base user guide in sync with knowledge-base · copilot · auto (Claude Sonnet 5.5) · ~177 AIC · ⌖ ~24 AIC · ⊞ 4.8K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 13, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants