Skip to content

Keep internal plans and test runbooks off the docs site - #139

Open
austin-barrington wants to merge 1 commit into
mainfrom
docs/exclude-internal-pages
Open

austin-barrington wants to merge 1 commit into
mainfrom
docs/exclude-internal-pages

Conversation

@austin-barrington

Copy link
Copy Markdown
Member

Excludes docs/superpowers/, developer-guide/sharding-real-world-test-plan.md and developer-guide/linear-scaling-scaledown-runbook.md from the MkDocs build. They were not in the nav but were published and listed in the sitemap at docs.hyperbyte.cloud.

The files stay in the repo. The code review rubric and dependency audit are still published, since the contributor guide links to them.

mkdocs build --strict passes; the sitemap goes from 56 to 48 URLs and none of the excluded paths appear in it or in the search index.

The superpowers/ design plans, the sharding real-world test plan and
the scale-down runbook were built and listed in the public sitemap.
Exclude them from the build; they stay in the repo.
@cursor

cursor Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

PR Summary

Low Risk
MkDocs-only publish filter with no application or data-path changes.

Overview
Adds an exclude_docs block to mkdocs.yml so internal material is not emitted on docs.hyperbyte.cloud even when it is absent from the nav.

Excluded paths: docs/superpowers/, developer-guide/sharding-real-world-test-plan.md, and developer-guide/linear-scaling-scaledown-runbook.md. Sources stay in the repository; only the public build, sitemap, and search index omit them. Other docs linked from the contributor guide (e.g. code review rubric, dependency audit) remain published.

Reviewed by Cursor Bugbot for commit e4896ae. Configure here.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Cursor Bugbot completed successfully with no findings that need human review, and the change is limited to MkDocs publish exclusions in mkdocs.yml. No prior approval from this automation needed to be dismissed.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant