Skip to content

Chore: LLMs generator#463

Open
scode2277 wants to merge 2 commits intodevelopfrom
chore/llms-generation
Open

Chore: LLMs generator#463
scode2277 wants to merge 2 commits intodevelopfrom
chore/llms-generation

Conversation

@scode2277
Copy link
Copy Markdown
Collaborator

@scode2277 scode2277 commented Apr 22, 2026

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:

  • Describe your changes, substitute this text with the information
  • If you are touching an existing piece of content, tag current contributors from the attribution list
  • If there is a steward for that framework, ask the steward to review it
  • If you're modifying the general outline, make sure to update it in the vocs.config.ts adding the dev: true parameter
  • If you need feedback for your content from the wider community, share the PR in our Discord
  • Review changes to ensure there are no typos; see instructions below.

@scode2277 scode2277 added the enhancement Updates that improve or refine existing features, user experience, or system performance. label Apr 22, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 22, 2026

Sidebar Configuration Reminder

This PR includes added, renamed, or removed documentation files:

  • docs/pages/intro/llms.mdx (added)

Please ensure that:

  • The sidebar in vocs.config.tsx has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

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.

Copy link
Copy Markdown
Collaborator

@frameworks-volunteer frameworks-volunteer left a comment

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Updates that improve or refine existing features, user experience, or system performance.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants