docs: fix orphan pages and update stale rulesets content#505
Merged
danielmeppiel merged 2 commits intomainfrom Mar 31, 2026
Merged
docs: fix orphan pages and update stale rulesets content#505danielmeppiel merged 2 commits intomainfrom
danielmeppiel merged 2 commits intomainfrom
Conversation
Fix two sidebar orphans and update outdated governance content: - Add ci-policy-setup to Guides sidebar (214-line tutorial was unreachable) - Add policy-reference to Enterprise sidebar (501-line schema ref was unreachable) - Update github-rulesets.md: expand 'What It Catches' beyond Unicode to cover lockfile consistency and policy enforcement checks - Update governance levels table: mark --ci and --policy as Available (were incorrectly listed as Planned since PR #365 shipped them) - Add Related/See-also footers to ci-policy-setup.md, policy-reference.md, and github-rulesets.md for navigational symmetry - Bump agent-workflows sidebar order to 9 (ci-policy-setup takes 8) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes gaps in the Starlight docs sidebar navigation for policy-related pages and refreshes the GitHub Rulesets documentation to reflect the current apm audit --ci / policy capabilities.
Changes:
- Adds previously orphaned pages (
ci-policy-setup,policy-reference) to the Starlight sidebar indocs/astro.config.mjs. - Updates
github-rulesets.mdto describe baseline vs policy checks and refresh governance level status. - Adds symmetric cross-links via new "Related" sections in policy setup/reference docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/integrations/github-rulesets.md | Expands/updates Rulesets page content and related links (some --ci behavior details need correction). |
| docs/src/content/docs/guides/ci-policy-setup.md | Adjusts sidebar ordering and adds a "Related" section for navigation. |
| docs/src/content/docs/guides/agent-workflows.md | Bumps sidebar order to make room for CI policy guide. |
| docs/src/content/docs/enterprise/policy-reference.md | Adds a "Related" section to improve navigability. |
| docs/astro.config.mjs | Registers orphan pages in the Guides/Enterprise sidebars so they appear in navigation. |
Comments suppressed due to low confidence (2)
docs/src/content/docs/integrations/github-rulesets.md:75
- The exit code description here doesn't match
--cimode.apm audit --ciexits 0 when clean and 1 if any CI check fails (no exit code 2 for warnings). Since this section is describing--ci/policy checks, please adjust the wording to reflect the--ciexit-code contract (and, if needed, separately document the 0/1/2 behavior for non---cicontent scanning).
When issues are detected, the command exits with a non-zero status code (1 = critical, 2 = warnings) and the check fails.
docs/src/content/docs/integrations/github-rulesets.md:66
- The "Lockfile consistency" bullet claims
apm audit --cidetects modified files and unresolved dependencies. The baseline CI checks primarily validate lockfile presence, ref/config consistency, orphaned packages, and that deployed files listed in the lockfile exist on disk; they do not verify file contents for modification nor perform dependency resolution. Please tighten this description to match what--ciactually checks today.
- **Lockfile consistency** (`apm audit --ci`) -- verifies installed packages match the lockfile, detects missing or modified files, and checks for unresolved dependencies
Separate content scanning, CI baseline, and policy enforcement into three distinct tiers with accurate exit code semantics: - Plain apm audit: critical (exit 1) vs warning (exit 2) - apm audit --ci: binary pass/fail, warnings do NOT block CI - apm audit --ci --policy: adds organizational policy checks Addresses review comment about zero-width characters being WARNING severity and not failing --ci mode. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
Problem
Two critical policy documentation pages were sidebar orphans — they existed on disk but were never added to
astro.config.mjs, making them invisible to anyone navigating the docs sidebar. Additionally,github-rulesets.mdwas stale, describing shipped features as "Planned."Impact
A user navigating the sidebar could find the concept of governance (via
governance.md) but not the implementation instructions (ci-policy-setup.md) or the schema reference (policy-reference.md). The policy story had a two-page hole in the middle of its navigation.Changes
Sidebar fixes (critical)
ci-policy-setupto Guides sidebar — 214-line step-by-step tutorial was unreachablepolicy-referenceto Enterprise sidebar — 501-line schema reference was unreachableagent-workflowssidebar order to 9 (ci-policy-setup takes 8)Content updates (
github-rulesets.md)apm audit --ciand--policy orgmarked as Available (were incorrectly listed as "Planned" since PR feat(policy): Phase 1 — org-level policy engine forapm audit --ci#365 shipped them)Cross-link footers
ci-policy-setup.mdandpolicy-reference.mdfor navigational symmetrygithub-rulesets.md"Related" section with links to governance, policy-reference, and ci-policy-setupTesting