Skip to content

fix(llms): exclude changelog entries from llms.txt #80

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

Merged
nibzard merged 1 commit into from
Jul 29, 2026
Merged

fix(llms): exclude changelog entries from llms.txt #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 50 additions & 56 deletions scripts/generate-llms-txt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,62 +50,56 @@ function shouldIncludePage(page: any): boolean {
function getAllPages(): PageMetadata[] {
const sourcePages = source.getPages();

return (
sourcePages
.filter(shouldIncludePage)
.map((page) => {
// Extract section from URL (split by / and filter out empty strings)
const urlParts = page.url.split('/').filter(Boolean);
const section = urlParts.slice(0, -1); // All parts except the last one

// Clean URL for content links (remove locale prefix)
let cleanUrl = page.url;
const locales = ['en', 'es']; // Add your supported locales here
if (urlParts.length > 0 && locales.includes(urlParts[0])) {
// Remove the locale prefix for content links
cleanUrl = '/' + urlParts.slice(1).join('/');
}

const frontmatter = getFrontmatter(page);

// Build a disambiguated title: if the title is generic (e.g. "Overview",
// "Quickstart"), prepend the parent section for clarity.
const toTitleCase = (s: string) =>
s.replace(/-/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase());
const dataTitle = (frontmatter as any)?.title as string | undefined;
const rawTitle: string = dataTitle || toTitleCase(page.file.name);
const GENERIC_TITLES = [
'overview',
'quickstart',
'quickstart-py',
'quickstart-ts',
'index',
'introduction',
'getting-started',
'integrations-overview',
];
const isGeneric = GENERIC_TITLES.includes(rawTitle.toLowerCase().replace(/\s+/g, '-'));
let title = rawTitle;
if (isGeneric && section.length > 0) {
const parent = toTitleCase(section[section.length - 1]);
title = `${parent} ${toTitleCase(rawTitle)}`;
}

return {
title,
description: ((frontmatter as any)?.description as string | undefined) || '',
url: page.url, // Keep original URL for file path generation
cleanUrl: cleanUrl, // Add clean URL for content links
section: section,
};
})
// .filter(
// (page) =>
// !page.url.includes("/changelog/") &&
// !page.section.includes("changelog"),
// )
.sort((a, b) => a.url.localeCompare(b.url))
);
return sourcePages
.filter(shouldIncludePage)
.map((page) => {
// Extract section from URL (split by / and filter out empty strings)
const urlParts = page.url.split('/').filter(Boolean);
const section = urlParts.slice(0, -1); // All parts except the last one

// Clean URL for content links (remove locale prefix)
let cleanUrl = page.url;
const locales = ['en', 'es']; // Add your supported locales here
if (urlParts.length > 0 && locales.includes(urlParts[0])) {
// Remove the locale prefix for content links
cleanUrl = '/' + urlParts.slice(1).join('/');
}

const frontmatter = getFrontmatter(page);

// Build a disambiguated title: if the title is generic (e.g. "Overview",
// "Quickstart"), prepend the parent section for clarity.
const toTitleCase = (s: string) =>
s.replace(/-/g, ' ').replace(/\b\w/g, (c) => c.toUpperCase());
const dataTitle = (frontmatter as any)?.title as string | undefined;
const rawTitle: string = dataTitle || toTitleCase(page.file.name);
const GENERIC_TITLES = [
'overview',
'quickstart',
'quickstart-py',
'quickstart-ts',
'index',
'introduction',
'getting-started',
'integrations-overview',
];
const isGeneric = GENERIC_TITLES.includes(rawTitle.toLowerCase().replace(/\s+/g, '-'));
let title = rawTitle;
if (isGeneric && section.length > 0) {
const parent = toTitleCase(section[section.length - 1]);
title = `${parent} ${toTitleCase(rawTitle)}`;
}

return {
title,
description: ((frontmatter as any)?.description as string | undefined) || '',
url: page.url, // Keep original URL for file path generation
cleanUrl: cleanUrl, // Add clean URL for content links
section: section,
};
})
.filter((page) => !page.url.includes('/changelog/') && !page.section.includes('changelog'))
.sort((a, b) => a.url.localeCompare(b.url));
}

function formatPageUrl(cleanUrl: string): string {
Expand Down
Loading