mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
* docs: radical reduction of documentation scope for v6 beta Archive and basement unreviewed content to ship a focused, minimal doc set. Changes: - Archive stale how-to workflow guides (will rewrite for v6) - Archive outdated explanation and reference content - Move unreviewed content to basement for later review - Reorganize TEA docs into dedicated /tea/ section - Add workflow-map visual reference page - Simplify getting-started tutorial and sidebar navigation - Add explanation pages: brainstorming, adversarial-review, party-mode, quick-flow, advanced-elicitation - Fix base URL handling for subdirectory deployments (GitHub Pages forks) The goal is a minimal, accurate doc set for beta rather than comprehensive but potentially misleading content. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor: restructure BMM and agents documentation by consolidating and flattening index files. --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
170 lines
4.7 KiB
JavaScript
170 lines
4.7 KiB
JavaScript
// @ts-check
|
|
import { defineConfig } from 'astro/config';
|
|
import starlight from '@astrojs/starlight';
|
|
import sitemap from '@astrojs/sitemap';
|
|
import rehypeMarkdownLinks from './src/rehype-markdown-links.js';
|
|
import rehypeBasePaths from './src/rehype-base-paths.js';
|
|
import { getSiteUrl } from './src/lib/site-url.js';
|
|
|
|
const siteUrl = getSiteUrl();
|
|
const urlParts = new URL(siteUrl);
|
|
// Normalize basePath: ensure trailing slash so links can use `${BASE_URL}path`
|
|
const basePath = urlParts.pathname === '/' ? '/' : urlParts.pathname.endsWith('/') ? urlParts.pathname : urlParts.pathname + '/';
|
|
|
|
export default defineConfig({
|
|
site: `${urlParts.origin}${basePath}`,
|
|
base: basePath,
|
|
outDir: '../build/site',
|
|
|
|
// Disable aggressive caching in dev mode
|
|
vite: {
|
|
optimizeDeps: {
|
|
force: true, // Always re-bundle dependencies
|
|
},
|
|
server: {
|
|
watch: {
|
|
usePolling: false, // Set to true if file changes aren't detected
|
|
},
|
|
},
|
|
},
|
|
|
|
markdown: {
|
|
rehypePlugins: [
|
|
[rehypeMarkdownLinks, { base: basePath }],
|
|
[rehypeBasePaths, { base: basePath }],
|
|
],
|
|
},
|
|
|
|
integrations: [
|
|
sitemap(),
|
|
starlight({
|
|
title: 'BMAD Method',
|
|
tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.',
|
|
|
|
logo: {
|
|
light: './public/img/bmad-light.png',
|
|
dark: './public/img/bmad-dark.png',
|
|
alt: 'BMAD Method',
|
|
replacesTitle: true,
|
|
},
|
|
favicon: '/favicon.ico',
|
|
|
|
// Social links
|
|
social: [
|
|
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/gk8jAdXWmj' },
|
|
{ icon: 'github', label: 'GitHub', href: 'https://github.com/bmad-code-org/BMAD-METHOD' },
|
|
{ icon: 'youtube', label: 'YouTube', href: 'https://www.youtube.com/@BMadCode' },
|
|
],
|
|
|
|
// Show last updated timestamps
|
|
lastUpdated: true,
|
|
|
|
// Custom head tags for LLM discovery
|
|
head: [
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'ai-terms',
|
|
content: `AI-optimized documentation: ${siteUrl}/llms-full.txt (plain text, ~100k tokens, complete BMAD reference). Index: ${siteUrl}/llms.txt`,
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'llms-full',
|
|
content: `${siteUrl}/llms-full.txt`,
|
|
},
|
|
},
|
|
{
|
|
tag: 'meta',
|
|
attrs: {
|
|
name: 'llms',
|
|
content: `${siteUrl}/llms.txt`,
|
|
},
|
|
},
|
|
],
|
|
|
|
// Custom CSS
|
|
customCss: ['./src/styles/custom.css'],
|
|
|
|
// Sidebar configuration (Diataxis structure)
|
|
sidebar: [
|
|
{ label: 'Welcome', slug: 'index' },
|
|
{
|
|
label: 'Tutorials',
|
|
collapsed: false,
|
|
autogenerate: { directory: 'tutorials' },
|
|
},
|
|
{
|
|
label: 'How-To Guides',
|
|
collapsed: true,
|
|
autogenerate: { directory: 'how-to' },
|
|
},
|
|
{
|
|
label: 'Explanation',
|
|
collapsed: true,
|
|
autogenerate: { directory: 'explanation' },
|
|
},
|
|
{
|
|
label: 'Reference',
|
|
collapsed: true,
|
|
autogenerate: { directory: 'reference' },
|
|
},
|
|
{
|
|
label: 'TEA - Testing in BMAD',
|
|
collapsed: true,
|
|
items: [
|
|
{
|
|
label: 'Tutorials',
|
|
autogenerate: { directory: 'tea/tutorials' },
|
|
},
|
|
{
|
|
label: 'How-To Guides',
|
|
items: [
|
|
{
|
|
label: 'Workflows',
|
|
autogenerate: { directory: 'tea/how-to/workflows' },
|
|
},
|
|
{
|
|
label: 'Customization',
|
|
autogenerate: { directory: 'tea/how-to/customization' },
|
|
},
|
|
{
|
|
label: 'Brownfield',
|
|
autogenerate: { directory: 'tea/how-to/brownfield' },
|
|
},
|
|
],
|
|
},
|
|
{
|
|
label: 'Explanation',
|
|
autogenerate: { directory: 'tea/explanation' },
|
|
},
|
|
{
|
|
label: 'Reference',
|
|
autogenerate: { directory: 'tea/reference' },
|
|
},
|
|
],
|
|
},
|
|
],
|
|
|
|
// Credits in footer
|
|
credits: false,
|
|
|
|
// Pagination
|
|
pagination: false,
|
|
|
|
// Use our docs/404.md instead of Starlight's built-in 404
|
|
disable404Route: true,
|
|
|
|
// Custom components
|
|
components: {
|
|
Header: './src/components/Header.astro',
|
|
MobileMenuFooter: './src/components/MobileMenuFooter.astro',
|
|
},
|
|
|
|
// Table of contents
|
|
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 3 },
|
|
}),
|
|
],
|
|
});
|