feat: add documentation website with Docusaurus build pipeline (#1177)

* feat: add documentation website with Docusaurus build pipeline

* feat(docs): add AI discovery meta tags for llms.txt files

- Add global headTags with ai-terms, llms, llms-full meta tags
- Update landing page link to clarify AI context purpose

* fix(docs): restore accidentally deleted faq.md and glossary.md

Files were removed in 12dd97fe during path restructuring.

* fix(docs): update broken project-readme links to GitHub URL

* feat(schema): add compound trigger format validation
This commit is contained in:
Alex Verkhovsky
2025-12-23 07:01:36 -08:00
committed by GitHub
parent 925b715d4f
commit 19df17b261
163 changed files with 20878 additions and 1509 deletions

View File

@@ -0,0 +1,81 @@
# Downloads
Download BMAD Method resources for offline use, AI training, or integration.
## LLM-Optimized Files
These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window.
| File | Description | Use Case |
| ----------------------------------- | ----------------------------------- | -------------------------- |
| **[llms.txt](/llms.txt)** | Documentation index with summaries | Quick overview, navigation |
| **[llms-full.txt](/llms-full.txt)** | Complete documentation concatenated | Full context loading |
### Using with LLMs
**Claude Projects:**
```
Upload llms-full.txt as project knowledge
```
**ChatGPT:**
```
Paste llms.txt for navigation, or sections from llms-full.txt as needed
```
**API Usage:**
```python
import requests
docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt").text
# Include in your system prompt or context
```
## Source Bundles
Download the complete source code for offline development or contribution.
| Bundle | Contents |
| --------------------------------------------------- | ------------------------------------------- |
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete `/src/` directory with all modules |
| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent prompts and workflows from `/_bmad/` |
## Installation Options
### NPM (Recommended)
```bash
npx bmad-method@alpha install
```
### Manual Installation
1. Download `bmad-prompts.zip`
2. Extract to your project root
3. Configure your IDE per the [IDE Guides](/docs/ide-info/)
## Version Information
- **Current Version:** See [CHANGELOG](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)
- **Release Notes:** Available on [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases)
## API Access
For programmatic access to BMAD documentation:
```bash
# Get documentation index
curl https://bmad-code-org.github.io/BMAD-METHOD/llms.txt
# Get full documentation
curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
```
## Contributing
Want to improve BMAD Method? Check out:
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)

View File

@@ -0,0 +1,50 @@
import React from 'react';
import Layout from '@theme/Layout';
import Link from '@docusaurus/Link';
import useBaseUrl from '@docusaurus/useBaseUrl';
export default function Home() {
const llmsFullUrl = useBaseUrl('/llms-full.txt');
return (
<Layout title="Home" description="BMAD Method - AI-driven agile development">
<main
style={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
justifyContent: 'center',
minHeight: 'calc(100vh - 200px)',
textAlign: 'center',
padding: '2rem',
}}
>
<h1 style={{ fontSize: '3rem', marginBottom: '0.5rem' }}>BMAD Method</h1>
<p
style={{
fontSize: '1.5rem',
color: 'var(--ifm-color-emphasis-600)',
marginBottom: '2rem',
}}
>
Under Construction
</p>
<Link to="/docs/" className="button button--primary button--lg" style={{ marginBottom: '3rem' }}>
View Documentation
</Link>
<a
href={llmsFullUrl}
title="Complete BMAD documentation in a single file for AI assistants"
style={{
fontSize: '0.875rem',
color: 'var(--ifm-color-emphasis-500)',
}}
>
🤖 AI Context: llms-full.txt
</a>
</main>
</Layout>
);
}