feat: add llms.txt standard support for AI agent discoverability (#784)
Cherry-picked website/, scripts/generate-llms-full.sh, and deploy-docs.yml from joyshmitz's PR. Fixed workflow to trigger on main branch instead of docs/docusaurus-site. Features: - Docusaurus documentation site with llms.txt support - Environment-variable driven config (defaults to steveyegge org) - Automated llms-full.txt generation from docs - GitHub Pages deployment workflow Co-authored-by: joyshmitz <joyshmitz@users.noreply.github.com> 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Executed-By: beads/crew/dave Rig: beads Role: crew
This commit is contained in:
120
website/docs/integrations/aider.md
Normal file
120
website/docs/integrations/aider.md
Normal file
@@ -0,0 +1,120 @@
|
||||
---
|
||||
id: aider
|
||||
title: Aider
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Aider Integration
|
||||
|
||||
How to use beads with Aider.
|
||||
|
||||
## Setup
|
||||
|
||||
### Quick Setup
|
||||
|
||||
```bash
|
||||
bd setup aider
|
||||
```
|
||||
|
||||
This creates/updates `.aider.conf.yml` with beads context.
|
||||
|
||||
### Verify Setup
|
||||
|
||||
```bash
|
||||
bd setup aider --check
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The setup adds to `.aider.conf.yml`:
|
||||
|
||||
```yaml
|
||||
# Beads integration
|
||||
read:
|
||||
- .beads/issues.jsonl
|
||||
|
||||
# Optional: Auto-run bd prime
|
||||
auto-commits: false
|
||||
```
|
||||
|
||||
## Workflow
|
||||
|
||||
### Start Session
|
||||
|
||||
```bash
|
||||
# Aider will have access to issues via .aider.conf.yml
|
||||
aider
|
||||
|
||||
# Or manually inject context
|
||||
bd prime | aider --message-file -
|
||||
```
|
||||
|
||||
### During Work
|
||||
|
||||
Use bd commands alongside aider:
|
||||
|
||||
```bash
|
||||
# In another terminal or after exiting aider
|
||||
bd create "Found bug during work" --deps discovered-from:bd-42 --json
|
||||
bd update bd-42 --status in_progress
|
||||
bd ready
|
||||
```
|
||||
|
||||
### End Session
|
||||
|
||||
```bash
|
||||
bd sync
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Keep issues visible** - Aider reads `.beads/issues.jsonl`
|
||||
2. **Sync regularly** - Run `bd sync` after significant changes
|
||||
3. **Use discovered-from** - Track issues found during work
|
||||
4. **Document context** - Include descriptions in issues
|
||||
|
||||
## Example Workflow
|
||||
|
||||
```bash
|
||||
# 1. Check ready work
|
||||
bd ready
|
||||
|
||||
# 2. Start aider with issue context
|
||||
aider --message "Working on bd-42: Fix auth bug"
|
||||
|
||||
# 3. Work in aider...
|
||||
|
||||
# 4. Create discovered issues
|
||||
bd create "Found related bug" --deps discovered-from:bd-42 --json
|
||||
|
||||
# 5. Complete and sync
|
||||
bd close bd-42 --reason "Fixed"
|
||||
bd sync
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Config not loading
|
||||
|
||||
```bash
|
||||
# Check config exists
|
||||
cat .aider.conf.yml
|
||||
|
||||
# Regenerate
|
||||
bd setup aider
|
||||
```
|
||||
|
||||
### Issues not visible
|
||||
|
||||
```bash
|
||||
# Check JSONL exists
|
||||
ls -la .beads/issues.jsonl
|
||||
|
||||
# Export if missing
|
||||
bd export
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [Claude Code](/integrations/claude-code)
|
||||
- [IDE Setup](/getting-started/ide-setup)
|
||||
Reference in New Issue
Block a user