Conversation
…works we have + changed titles to 2 pages as previously confusing
Sidebar Configuration ReminderThis PR includes added, renamed, or removed documentation files:
Please ensure that:
See Contributing Guide – Sidebar & Navigation for more details. This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message. |
frameworks-volunteer
left a comment
There was a problem hiding this comment.
Model: z-ai/glm-5.1 Reasoning: high Provider: openrouter
Approving. Clean implementation that follows existing patterns well.
Security: No concerns. The script is build-time only -- reads local MDX files and writes to dist. No eval, no child_process, no network calls, no secrets. Env var usage (CF_PAGES_BRANCH, CF_PAGES_URL) matches sitemap-generator.js. gray-matter is already a project dependency.
QA: Script reuses the same vocs.config.tsx regex and sidebar-ordering approach as sitemap-generator.js. The dev:true filtering is actually more thorough (double layer: line-level in config + frontmatter data.dev check). DPRK title fixes are correct -- they remove "Overview" from non-overview pages which would cause confusing section headers in the generated output. The llms.mdx page matches the frontmatter pattern of other intro pages (no contributors field). CI green.
I've created a script that runs post build and generates LLM-friendly documentation overriding vocs default one.
What it generates:
All files start with instructions for AI assistants on how to cite the source, when to fetch other files, and where to look if the question spans multiple frameworks.
All files are branch aware so on main, dev: true pages are excluded and on develop all pages are included so contributors get full coverage. Same thing for the links in the files, they change based on the branch/site they files are builded.
Other than that, i've also added a file at the end of the sidebar that explains how to use the files we generate and how to route to them directly following the naming structure -> https://chore-llms-generation.frameworks-573.pages.dev/intro/llms
Also fixed a couple of titles in the DPRK IT Workers fw as they were were causing wrong section headers in the output (title mentioned "overview" in a file that was not the overview one)
Frameworks PR Checklist
Thank you for contributing to the Security Frameworks! Before you open a PR, make sure to read information for contributors and take a look at the following checklist:
vocs.config.tsadding thedev: trueparameter