Skip to content

docs: improve markdown docs script #8970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+1,004 −162
Open

docs: improve markdown docs script #8970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9d1304
docs: improve markdown docs script
reidbarber Oct 3, 2025
18bf9e3
include page descriptions in initial mcp index build
reidbarber Oct 3, 2025
4675e45
Merge branch 'main' into fix-markdown-docs-script
reidbarber Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/dev/mcp/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,18 @@ async function buildPageIndex(library: Library): Promise<PageInfo[]> {
// Read llms.txt to enumerate available pages without downloading them all.
const llmsUrl = `${libBaseUrl(library)}/llms.txt`;
const txt = await fetchText(llmsUrl);
const re = /^\s*-\s*\[([^\]]+)\]\(([^)]+)\)\s*$/;
const re = /^\s*-\s*\[([^\]]+)\]\(([^)]+)\)(?:\s*:\s*(.*))?\s*$/;
for (const line of txt.split(/\r?\n/)) {
const m = line.match(re);
if (!m) {continue;}
const display = (m[1] || '').trim();
const href = (m[2] || '').trim();
const desc = (m[3] || '').trim() || undefined;
if (!href || !/\.md$/i.test(href)) {continue;}
const key = href.replace(/\.md$/i, '').replace(/\\/g, '/');
const title = display || path.basename(key);
const url = `${DEFAULT_CDN_BASE}/${key}.md`;
const info: PageInfo = {key, title, description: undefined, filePath: url, sections: []};
const info: PageInfo = {key, title, description: desc, filePath: url, sections: []};
pages.push(info);
pageCache.set(info.key, info);
}
Expand Down
1 change: 1 addition & 0 deletions packages/dev/s2-docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
}
},
"dependencies": {
"@babel/parser": "^7.26.3",
"@parcel/plugin": "^2.16.0",
"@parcel/rsc": "^2.16.0",
"@react-aria/focus": "^3.20.4",
Expand Down
Loading