Skip to content

Fix test suite documentation links#1997

Merged
merill merged 1 commit into
mainfrom
codex/fix-test-suite-links
Jul 25, 2026
Merged

Fix test suite documentation links#1997
merill merged 1 commit into
mainfrom
codex/fix-test-suite-links

Conversation

@merill

@merill merill commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Generate suite index links using their actual Markdown source paths (./<test-id>.md).
  • Update the current and v2.1.0 suite indexes for Maester, EIDSCA, CISA, CIS, and ORCA.

Why

Suite index links were emitted as extensionless parent-relative URLs such as ../EIDSCA.AF01. When a suite page was reached through client-side navigation without a trailing slash, the browser resolved those links one directory too high (for example, /docs/EIDSCA.AF01 instead of /docs/tests/EIDSCA.AF01), resulting in a 404.

Including the Markdown extension lets Docusaurus resolve each source document to the correct absolute, version-aware permalink during compilation, independent of trailing-slash behavior.

Impact

Individual test links from all generated suite overview pages now open the correct test documentation. This fixes the reported EIDSCA and ORCA failures and prevents the same issue in the other suites.

Validation

  • Reproduced the production failures for EIDSCA.AF01 and ORCA.100 before the change.
  • Verified end-to-end local navigation from /docs/tests/eidsca to /docs/tests/EIDSCA.AF01.
  • Verified end-to-end local navigation from /docs/tests/orca to /docs/tests/ORCA.100.
  • Verified all 748 current and v2.1.0 suite-index link targets exist.
  • Verified the generator parses successfully with node --check.
  • Docusaurus client and server compilation completed successfully. Full static generation still encounters the existing unrelated command-overview useDocsSidebar context error on /docs/commands/ and /docs/next/commands/.

Summary by CodeRabbit

  • Documentation
    • Fixed test index links across current and versioned documentation.
    • Test entries now correctly open their corresponding Markdown detail pages.
    • Updated links for CIS, CISA, EIDSCA, Maester, and ORCA test suites.
    • Preserved existing test IDs, titles, severities, and categories.

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: a070137a-6f8b-4309-ac36-50c5f7191525

📥 Commits

Reviewing files that changed from the base of the PR and between 46c9bf6 and 441009b.

📒 Files selected for processing (11)
  • website/docs/tests/cis/readme.md
  • website/docs/tests/cisa/readme.md
  • website/docs/tests/eidsca/readme.md
  • website/docs/tests/maester/readme.md
  • website/docs/tests/orca/readme.md
  • website/scripts/generate-test-docs.mjs
  • website/versioned_docs/version-2.1.0/tests/cis/readme.md
  • website/versioned_docs/version-2.1.0/tests/cisa/readme.md
  • website/versioned_docs/version-2.1.0/tests/eidsca/readme.md
  • website/versioned_docs/version-2.1.0/tests/maester/readme.md
  • website/versioned_docs/version-2.1.0/tests/orca/readme.md

📝 Walkthrough

Walkthrough

Suite index generation and corresponding current/versioned documentation tables now link directly to same-directory Markdown test pages using ./<TestId>.md, without changing displayed test metadata.

Changes

Test documentation links

Layer / File(s) Summary
Update generated link targets
website/scripts/generate-test-docs.mjs
renderSuiteIndex now generates same-directory .md links for individual tests.
Regenerate suite indexes
website/docs/tests/*/readme.md, website/versioned_docs/version-2.1.0/tests/*/readme.md
CIS, CISA, EIDSCA, Maester, and ORCA tables use ./<TestId>.md targets while preserving displayed IDs, titles, severities, and categories.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: fixing broken links in test suite documentation.
Description check ✅ Passed The description is specific and covers what changed, why, impact, and validation, though it doesn't follow the template exactly.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/fix-test-suite-links

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.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@merill
merill marked this pull request as ready for review July 25, 2026 06:08
@merill
merill requested a review from a team as a code owner July 25, 2026 06:08
@merill
merill merged commit 2452f6d into main Jul 25, 2026
10 of 12 checks passed
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