docs: hide CLI, Scaffold, and Hyperboards pages by Kzoeps · Pull Request #157 · hypercerts-org/documentation

Kzoeps · 2026-07-30T11:30:16Z

Summary

move the CLI, Scaffold, and Hyperboards pages from pages/tools/ to drafts/tools/
remove navigation, quick-link, and internal documentation references to those routes
keep the Markdown source available to restore later without generating public routes
add regression coverage that keeps archived pages outside pages/ and unlinked

Validation

pnpm test — 31 tests passed
pnpm build — passed; the three archived routes are not generated

vercel · 2026-07-30T11:30:22Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hypercerts-v0.2-documentation	Ready	Preview	Jul 30, 2026 11:46am

coderabbitai · 2026-07-30T11:30:43Z

📝 Walkthrough

Walkthrough

This change centralizes hidden tool routes, excludes them from search and sitemap generation, removes authored navigation references, updates related documentation, and adds tests verifying source availability and discoverability exclusions.

Changes

Hidden Tool Visibility

Layer / File(s)	Summary
Hidden route configuration and generated artifacts `lib/page-visibility.json`, `lib/generate-search-index.js`, `lib/generate-sitemap.js`	Defines hidden tool paths and filters matching routes from generated search and sitemap outputs.
Navigation and documentation references `lib/navigation.js`, `components/Layout.js`, `components/SearchDialog.js`, `pages/architecture/...`, `pages/getting-started/quickstart.md`, `pages/tools/hyperscan.md`	Removes hidden tool links, points the header Tools link to Agent Skills, updates quick links, and revises related documentation.
Hidden route validation `test/hidden-tool-visibility.test.js`	Checks that hidden tool Markdown sources exist and that their routes are absent from search indexes, sitemaps, and authored links.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

hypercerts-org/documentation#149: Adds the Agent Skills navigation entry retained by this change.
hypercerts-org/documentation#105: Introduces the search-index pipeline modified here to exclude hidden routes.
hypercerts-org/documentation#102: Also touches search indexing and SearchDialog integration.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: hiding the CLI, Scaffold, and Hyperboards pages from site visibility.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

Fix failing CI checks

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/hide-cli-scaffold-hyperboards

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

test/hidden-tool-visibility.test.js (1)
9-14: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Use the shared hidden-route configuration in the test.

This test duplicates lib/page-visibility.json, so adding a future hidden route can change production behavior without extending regression coverage. Import hiddenPaths and derive HIDDEN_PAGE_FILES from that shared value.
Proposed fix
-const HIDDEN_PATHS = [
-  '/tools/hypercerts-cli',
-  '/tools/scaffold',
-  '/tools/hyperboards',
-];
+const { hiddenPaths: HIDDEN_PATHS } = require('../lib/page-visibility.json');
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@test/hidden-tool-visibility.test.js` around lines 9 - 14, Update
test/hidden-tool-visibility.test.js to import the shared hiddenPaths
configuration from lib/page-visibility.json and derive HIDDEN_PAGE_FILES from
it, removing the duplicated HIDDEN_PATHS list. Preserve the existing
pages${path}.md mapping so the test automatically covers future hidden routes.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@test/hidden-tool-visibility.test.js`:
- Around line 29-30: Update the setup around the hidden-tool visibility test and
its execFileSync call to ensure external-docs-content.json is available before
invoking lib/generate-search-index.js. Use the repository’s documented
preparation step or add the required test fixture, while preserving the existing
hidden-page exclusion assertion.

---

Nitpick comments:
In `@test/hidden-tool-visibility.test.js`:
- Around line 9-14: Update test/hidden-tool-visibility.test.js to import the
shared hiddenPaths configuration from lib/page-visibility.json and derive
HIDDEN_PAGE_FILES from it, removing the duplicated HIDDEN_PATHS list. Preserve
the existing pages${path}.md mapping so the test automatically covers future
hidden routes.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1c75c9b9-92ef-487c-9bad-292a828fa9b7

📥 Commits

Reviewing files that changed from the base of the PR and between ab6e013 and 1f04cd2.

📒 Files selected for processing (10)

components/Layout.js
components/SearchDialog.js
lib/generate-search-index.js
lib/generate-sitemap.js
lib/navigation.js
lib/page-visibility.json
pages/architecture/account-and-identity.md
pages/getting-started/quickstart.md
pages/tools/hyperscan.md
test/hidden-tool-visibility.test.js

💤 Files with no reviewable changes (3)

pages/tools/hyperscan.md
components/SearchDialog.js
lib/navigation.js

coderabbitai · 2026-07-30T11:33:44Z

+test('excludes hidden tool pages from the generated search index', () => {
+  execFileSync(process.execPath, ['lib/generate-search-index.js'], { cwd: ROOT });


🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

Provide the external-docs-content prerequisite before running this test.

execFileSync invokes the search-index generator directly, but CI reports that it crashes with missing external-docs-content.json; the hidden-route assertion is never reached. Add test setup/fixtures for that prerequisite, or invoke the repository’s documented preparation step before generating the index.

🧰 Tools

🪛 GitHub Actions: Docs CI / 0_Test and build documentation.txt

[error] 29-30: Test failed: 'excludes hidden tool pages from the generated search index' (ERR_TEST_FAILURE) due to missing external docs content file.

🪛 GitHub Actions: Docs CI / Test and build documentation

[error] 29-30: Test failed: 'excludes hidden tool pages from the generated search index' due to missing external-docs-content.json (generate-search-index crashed with ERR_TEST_FAILURE).

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@test/hidden-tool-visibility.test.js` around lines 29 - 30, Update the setup around the hidden-tool visibility test and its execFileSync call to ensure external-docs-content.json is available before invoking lib/generate-search-index.js. Use the repository’s documented preparation step or add the required test fixture, while preserving the existing hidden-page exclusion assertion.

Source: Pipeline failures

Kzoeps added 3 commits July 30, 2026 17:15

docs: define hidden tool page visibility

197442f

docs: hide CLI, Scaffold, and Hyperboards pages

99326ac

docs: remove implementation design artifact

1f04cd2

vercel Bot deployed to Preview July 30, 2026 11:30 View deployment

coderabbitai Bot reviewed Jul 30, 2026

View reviewed changes

docs: archive hidden tool pages

b1985c3

vercel Bot deployed to Preview July 30, 2026 11:46 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: hide CLI, Scaffold, and Hyperboards pages - #157

docs: hide CLI, Scaffold, and Hyperboards pages#157
Kzoeps wants to merge 4 commits into
mainfrom
docs/hide-cli-scaffold-hyperboards

Kzoeps commented Jul 30, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jul 30, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 30, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jul 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		test('excludes hidden tool pages from the generated search index', () => {
		execFileSync(process.execPath, ['lib/generate-search-index.js'], { cwd: ROOT });

Uh oh!

Conversation

Kzoeps commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

vercel Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Kzoeps commented Jul 30, 2026 •

edited

Loading

vercel Bot commented Jul 30, 2026 •

edited

Loading

coderabbitai Bot commented Jul 30, 2026 •

edited

Loading