Skip to content

fix(#2969): use frontmatter title for directory sidebar entries and exclude non-content files #4020

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
waynesun09 merged 2 commits into from
Jul 10, 2026
Merged

fix(#2969): use frontmatter title for directory sidebar entries and exclude non-content files #4020

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24b657d
fix(#2969): use frontmatter title for directory sidebar entries and e…
fullsend-ai-coder[bot] Jul 10, 2026
9f3c2f3
fix: replace hardcoded sidebar exclusion lists with pattern-based rules
fullsend-ai-coder[bot] Jul 10, 2026
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
28 changes: 24 additions & 4 deletions website/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,41 @@ import { fileURLToPath } from "node:url";
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const docsDir = path.resolve(__dirname, "..", "..", "docs");

const excludeFiles = new Set([
"AGENTS.md",
"CLAUDE.md",
"CODEOWNERS",
"LICENSE",
"CONTRIBUTING.md",
]);
const excludeDirs = new Set([".github", "0000-experiment-template"]);
Comment thread
waynesun09 marked this conversation as resolved.
Resolved
Comment thread
waynesun09 marked this conversation as resolved.
Resolved

function getMarkdownFiles(dir: string, base: string): { text: string; link: string }[] {
const fullDir = path.resolve(docsDir, dir);
if (!fs.existsSync(fullDir)) return [];
const items: { text: string; link: string }[] = [];
for (const entry of fs.readdirSync(fullDir).sort()) {
const entryPath = path.resolve(fullDir, entry);
if (entry.endsWith(".md") && entry !== "README.md") {
if (entry.endsWith(".md") && entry !== "README.md" && !excludeFiles.has(entry)) {
const slug = entry.replace(/\.md$/, "");
const content = fs.readFileSync(entryPath, "utf-8");
const fmTitleMatch = content.match(/^title:\s*["']?(.+?)["']?\s*$/m);
const titleMatch = content.match(/^#\s+(.+)$/m);
items.push({ text: fmTitleMatch?.[1] || titleMatch?.[1] || slug, link: `/${base}/${slug}` });
} else if (fs.statSync(entryPath).isDirectory()) {
} else if (
fs.statSync(entryPath).isDirectory() &&
!excludeDirs.has(entry) &&
!entry.startsWith(".")
) {
const readme = path.resolve(entryPath, "README.md");
if (fs.existsSync(readme)) {
const content = fs.readFileSync(readme, "utf-8");
const fmTitleMatch = content.match(/^title:\s*["']?(.+?)["']?\s*$/m);
const titleMatch = content.match(/^#\s+(.+)$/m);
items.push({ text: titleMatch?.[1] || entry, link: `/${base}/${entry}/` });
items.push({
text: fmTitleMatch?.[1] || titleMatch?.[1] || entry,
link: `/${base}/${entry}/`,
});
}
}
}
Expand Down Expand Up @@ -209,7 +226,10 @@ export default defineConfig({
{ text: "Customizing Agents", link: "/guides/user/customizing-agents" },
{ text: "Customizing with AGENTS.md", link: "/guides/user/customizing-with-agents-md" },
{ text: "Customizing with Skills", link: "/guides/user/customizing-with-skills" },
{ text: "Building custom agents from scratch", link: "/guides/user/building-custom-agents" },
{
text: "Building custom agents from scratch",
link: "/guides/user/building-custom-agents",
},
{ text: "Running Agents Locally", link: "/guides/user/running-agents-locally" },
],
},
Expand Down
Loading