Skip to content

Docs CI - Check that nav.js matches the .md files list#2984

Merged
bfops merged 13 commits into
masterfrom
bfops/check-navjs
Jul 25, 2025
Merged

Docs CI - Check that nav.js matches the .md files list#2984
bfops merged 13 commits into
masterfrom
bfops/check-navjs

Conversation

@bfops
Copy link
Copy Markdown
Collaborator

@bfops bfops commented Jul 24, 2025

Description of Changes

I added a script that checks that the files listed in nav.js match all the .md files we can find in the docs directory.

API and ABI breaking changes

None

Expected complexity level and risk

2

Testing

@bfops bfops marked this pull request as ready for review July 24, 2025 17:45
@bfops bfops requested a review from jdetter July 24, 2025 17:46
@bfops bfops changed the title Docs - Check that nav.js matches the .md files list Docs CI - Check that nav.js matches the .md files list Jul 24, 2025
Comment thread .github/workflows/docs-validate-nav-build.yml
Copy link
Copy Markdown
Contributor

@jdetter jdetter left a comment

Choose a reason for hiding this comment

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

Ok here we're just verifying that everything listed in the navigation bar at least points to a valid .md file which seems like a good sanity check. Thanks Zeke!

@bfops bfops added this pull request to the merge queue Jul 25, 2025
Merged via the queue into master with commit 6c9aebd Jul 25, 2025
25 checks passed
@bfops bfops deleted the bfops/check-navjs branch July 30, 2025 17:19
mamcx pushed a commit that referenced this pull request Aug 26, 2025
Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
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.

2 participants