johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix broken relative links across documentation

Browse Source 
Fixes 46 broken relative links across 20 documentation files in docs/.

Changes:
- Added ../ prefix for root files (README.md, AGENTS.md)
- Removed ../ prefix for sibling docs files
- Removed dead links to non-existent files
- Fixed subdirectory paths

Based on PR #574 by chrisvaillancourt.

Co-Authored-By: Chris Vaillancourt <chrisvaillancourt@users.noreply.github.com>
This commit is contained in:
Steve Yegge
2025-12-16 00:46:08 -08:00
parent 8c45069228
commit 25ea1e7de3
20 changed files with 38 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/ADAPTIVE_IDS.md
View File

@@ -194,6 +194,5 @@ Potential improvements (not yet implemented):
## Related ## Related
- [Hash ID Design](HASH_ID_DESIGN.md) - Overview of hash-based IDs
- [Migration Guide](../README.md#migration) - Converting from sequential to hash IDs - [Migration Guide](../README.md#migration) - Converting from sequential to hash IDs
- [Configuration](../CONFIG.md) - All configuration options - [Configuration](CONFIG.md) - All configuration options

2
docs/ADVANCED.md
View File

@@ -365,7 +365,7 @@ Understanding the role of each component:
## Next Steps ## Next Steps
- **[README.md](README.md)** - Core features and quick start - **[README.md](../README.md)** - Core features and quick start
- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and solutions - **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and solutions
- **[FAQ.md](FAQ.md)** - Frequently asked questions - **[FAQ.md](FAQ.md)** - Frequently asked questions
- **[CONFIG.md](CONFIG.md)** - Configuration system guide - **[CONFIG.md](CONFIG.md)** - Configuration system guide

2
docs/AGENT_MAIL.md
View File

@@ -511,8 +511,6 @@ jobs:
- [ADR 002: Agent Mail Integration](adr/002-agent-mail-integration.md) - [ADR 002: Agent Mail Integration](adr/002-agent-mail-integration.md)
- [Agent Mail Repository](https://github.com/Dicklesworthstone/mcp_agent_mail) - [Agent Mail Repository](https://github.com/Dicklesworthstone/mcp_agent_mail)
- [Integration Status](../AGENT_MAIL_INTEGRATION_STATUS.md)
- [Latency Benchmark Results](../latency_results.md)
- [Python Agent Example](../examples/python-agent/) - [Python Agent Example](../examples/python-agent/)
## Contributing ## Contributing

2
docs/AGENT_MAIL_DEPLOYMENT.md
View File

@@ -623,7 +623,7 @@ After successful deployment:
- **Main Guide**: [AGENT_MAIL_MULTI_WORKSPACE_SETUP.md](AGENT_MAIL_MULTI_WORKSPACE_SETUP.md) - **Main Guide**: [AGENT_MAIL_MULTI_WORKSPACE_SETUP.md](AGENT_MAIL_MULTI_WORKSPACE_SETUP.md)
- **Quick Start**: [AGENT_MAIL_QUICKSTART.md](AGENT_MAIL_QUICKSTART.md) - **Quick Start**: [AGENT_MAIL_QUICKSTART.md](AGENT_MAIL_QUICKSTART.md)
- **Architecture**: [AGENT_MAIL.md](AGENT_MAIL.md) - **Architecture**: [AGENT_MAIL.md](AGENT_MAIL.md)
- **ADR**: [adr/002-agent-mail-integration.md](../adr/002-agent-mail-integration.md) - **ADR**: [adr/002-agent-mail-integration.md](adr/002-agent-mail-integration.md)
## Timeline Estimate ## Timeline Estimate

1
docs/AGENT_MAIL_QUICKSTART.md
View File

@@ -434,7 +434,6 @@ except Exception:
1. **Read the full guide**: [AGENT_MAIL.md](AGENT_MAIL.md) 1. **Read the full guide**: [AGENT_MAIL.md](AGENT_MAIL.md)
2. **Try the Python example**: [examples/python-agent/AGENT_MAIL_EXAMPLE.md](../examples/python-agent/AGENT_MAIL_EXAMPLE.md) 2. **Try the Python example**: [examples/python-agent/AGENT_MAIL_EXAMPLE.md](../examples/python-agent/AGENT_MAIL_EXAMPLE.md)
3. **Review the ADR**: [adr/002-agent-mail-integration.md](adr/002-agent-mail-integration.md) 3. **Review the ADR**: [adr/002-agent-mail-integration.md](adr/002-agent-mail-integration.md)
4. **Check out benchmarks**: [../latency_results.md](../latency_results.md)
## Getting Help ## Getting Help

2
docs/CLAUDE.md
View File

@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
**beads** (command: `bd`) is a git-backed issue tracker for AI-supervised coding workflows. We dogfood our own tool. **beads** (command: `bd`) is a git-backed issue tracker for AI-supervised coding workflows. We dogfood our own tool.
**IMPORTANT**: See [AGENTS.md](AGENTS.md) for complete workflow instructions, bd commands, and development guidelines. **IMPORTANT**: See [AGENTS.md](../AGENTS.md) for complete workflow instructions, bd commands, and development guidelines.
## Architecture Overview ## Architecture Overview

2
docs/CLI_REFERENCE.md
View File

@@ -555,5 +555,5 @@ bd sync # Force immediate sync, bypass debounce
- [AGENTS.md](../AGENTS.md) - Main agent workflow guide - [AGENTS.md](../AGENTS.md) - Main agent workflow guide
- [DAEMON.md](DAEMON.md) - Daemon management and event-driven mode - [DAEMON.md](DAEMON.md) - Daemon management and event-driven mode
- [GIT_INTEGRATION.md](GIT_INTEGRATION.md) - Git workflows and merge strategies - [GIT_INTEGRATION.md](GIT_INTEGRATION.md) - Git workflows and merge strategies
- [LABELS.md](../LABELS.md) - Label system guide - [LABELS.md](LABELS.md) - Label system guide
- [README.md](../README.md) - User documentation - [README.md](../README.md) - User documentation

3
docs/COLLISION_MATH.md
View File

@@ -143,5 +143,4 @@ This generates the tables above and shows adaptive scaling strategy for any thre
## Related Documentation ## Related Documentation
- [ADAPTIVE_IDS.md](ADAPTIVE_IDS.md) - Configuration and usage guide - [ADAPTIVE_IDS.md](ADAPTIVE_IDS.md) - Configuration and usage guide
- [HASH_ID_DESIGN.md](HASH_ID_DESIGN.md) - Overall hash ID design rationale - [CONFIG.md](CONFIG.md) - All configuration options
- [CONFIG.md](../CONFIG.md) - All configuration options

5
docs/CONFIG.md
View File

@@ -216,7 +216,7 @@ bd config set max_collision_prob "0.01"
bd config set min_hash_length "5" bd config set min_hash_length "5"
``` ```
See [docs/ADAPTIVE_IDS.md](docs/ADAPTIVE_IDS.md) for detailed documentation. See [ADAPTIVE_IDS.md](ADAPTIVE_IDS.md) for detailed documentation.
### Example: Export Error Handling ### Example: Export Error Handling
@@ -460,6 +460,5 @@ External integration scripts can read configuration to sync with Jira, Linear, G
## See Also ## See Also
- [README.md](README.md) - Main documentation - [README.md](../README.md) - Main documentation
- [EXTENDING.md](EXTENDING.md) - Database schema and compaction config - [EXTENDING.md](EXTENDING.md) - Database schema and compaction config
- [examples/integrations/](examples/integrations/) - Integration examples

4
docs/DAEMON.md
View File

@@ -436,7 +436,7 @@ rm .beads/.exclusive-lock
- CI/CD pipelines (controlled sync timing) - CI/CD pipelines (controlled sync timing)
- Testing frameworks (isolated test runs) - Testing frameworks (isolated test runs)
See [EXCLUSIVE_LOCK.md](../EXCLUSIVE_LOCK.md) for complete documentation. See [EXCLUSIVE_LOCK.md](EXCLUSIVE_LOCK.md) for complete documentation.
## Common Daemon Issues ## Common Daemon Issues
@@ -542,6 +542,6 @@ bd daemons killall
## See Also ## See Also
- [AGENTS.md](../AGENTS.md) - Main agent workflow guide - [AGENTS.md](../AGENTS.md) - Main agent workflow guide
- [EXCLUSIVE_LOCK.md](../EXCLUSIVE_LOCK.md) - External tool integration - [EXCLUSIVE_LOCK.md](EXCLUSIVE_LOCK.md) - External tool integration
- [GIT_INTEGRATION.md](GIT_INTEGRATION.md) - Git workflow and merge strategies - [GIT_INTEGRATION.md](GIT_INTEGRATION.md) - Git workflow and merge strategies
- [commands/daemons.md](../commands/daemons.md) - Daemon command reference - [commands/daemons.md](../commands/daemons.md) - Daemon command reference

2
docs/EXTENDING.md
View File

@@ -712,6 +712,6 @@ This pattern scales from simple scripts to complex orchestrators like VC.
## See Also ## See Also
- [README.md](README.md) - Complete bd documentation - [README.md](../README.md) - Complete bd documentation
- Run `bd quickstart` - Interactive tutorial - Run `bd quickstart` - Interactive tutorial
- Check out VC's implementation at `github.com/steveyegge/vc` for a real-world example - Check out VC's implementation at `github.com/steveyegge/vc` for a real-world example

8
docs/FAQ.md
View File

@@ -302,7 +302,7 @@ We don't have automated migration tools yet, but you can:
2. Write a simple script to convert to bd's JSONL format 2. Write a simple script to convert to bd's JSONL format
3. Import with `bd import -i issues.jsonl` 3. Import with `bd import -i issues.jsonl`
See [examples/](examples/) for scripting patterns. Contributions welcome! See [examples/](../examples/) for scripting patterns. Contributions welcome!
### Can I export back to GitHub Issues / Jira? ### Can I export back to GitHub Issues / Jira?
@@ -463,15 +463,15 @@ bd import -i .beads/issues.jsonl
### Where can I get more help? ### Where can I get more help?
- **Documentation**: [README.md](README.md), [QUICKSTART.md](QUICKSTART.md), [ADVANCED.md](ADVANCED.md) - **Documentation**: [README.md](../README.md), [QUICKSTART.md](QUICKSTART.md), [ADVANCED.md](ADVANCED.md)
- **Troubleshooting**: [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - **Troubleshooting**: [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
- **Examples**: [examples/](examples/) - **Examples**: [examples/](../examples/)
- **GitHub Issues**: [Report bugs or request features](https://github.com/steveyegge/beads/issues) - **GitHub Issues**: [Report bugs or request features](https://github.com/steveyegge/beads/issues)
- **GitHub Discussions**: [Ask questions](https://github.com/steveyegge/beads/discussions) - **GitHub Discussions**: [Ask questions](https://github.com/steveyegge/beads/discussions)
### How can I contribute? ### How can I contribute?
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for: Contributions are welcome! See [CONTRIBUTING.md](../CONTRIBUTING.md) for:
- Code contribution guidelines - Code contribution guidelines
- How to run tests - How to run tests

6
docs/INSTALLING.md
View File

@@ -210,7 +210,7 @@ Add to your MCP settings:
- ❌ Higher context overhead (MCP schemas add 10-50k tokens) - ❌ Higher context overhead (MCP schemas add 10-50k tokens)
- ❌ Additional latency from MCP protocol - ❌ Additional latency from MCP protocol
See [integrations/beads-mcp/README.md](integrations/beads-mcp/README.md) for detailed MCP server documentation. See [integrations/beads-mcp/README.md](../integrations/beads-mcp/README.md) for detailed MCP server documentation.
## Verifying Installation ## Verifying Installation
@@ -286,9 +286,9 @@ See the "Claude Code Plugin" section above for alternative installation methods
After installation: After installation:
1. **Initialize a project**: `cd your-project && bd init` 1. **Initialize a project**: `cd your-project && bd init`
2. **Configure your agent**: Add bd instructions to `AGENTS.md` (see [README.md](README.md#quick-start)) 2. **Configure your agent**: Add bd instructions to `AGENTS.md` (see [README.md](../README.md#quick-start))
3. **Learn the basics**: Run `bd quickstart` for an interactive tutorial 3. **Learn the basics**: Run `bd quickstart` for an interactive tutorial
4. **Explore examples**: Check out the [examples/](examples/) directory 4. **Explore examples**: Check out the [examples/](../examples/) directory
## Updating bd ## Updating bd

5
docs/LABELS.md
View File

@@ -525,7 +525,6 @@ bd import -i .beads/issues.jsonl
## See Also ## See Also
- [README.md](README.md) - Main documentation - [README.md](../README.md) - Main documentation
- [AGENTS.md](AGENTS.md) - AI agent integration guide - [AGENTS.md](../AGENTS.md) - AI agent integration guide
- [AGENTS.md](AGENTS.md) - Team workflow patterns
- [ADVANCED.md](ADVANCED.md) - JSONL format details - [ADVANCED.md](ADVANCED.md) - JSONL format details

16
docs/MULTI_REPO_MIGRATION.md
View File

@@ -10,7 +10,7 @@ This guide helps you adopt beads' multi-repo workflow for OSS contributions, tea
- [Multi-Phase Development](#multi-phase-development) - Separate repos per phase - [Multi-Phase Development](#multi-phase-development) - Separate repos per phase
- [Multiple Personas](#multiple-personas) - Architect vs. implementer separation - [Multiple Personas](#multiple-personas) - Architect vs. implementer separation
**New to beads?** See [QUICKSTART.md](../QUICKSTART.md) first. **New to beads?** See [QUICKSTART.md](QUICKSTART.md) first.
## What is Multi-Repo Mode? ## What is Multi-Repo Mode?
@@ -398,7 +398,7 @@ bd list --json
**Problem:** Multiple repos modifying same JSONL file. **Problem:** Multiple repos modifying same JSONL file.
**Solution:** See [TROUBLESHOOTING.md](../TROUBLESHOOTING.md#git-merge-conflicts) and consider [beads-merge](https://github.com/neongreen/mono/tree/main/beads-merge) tool. **Solution:** See [TROUBLESHOOTING.md](TROUBLESHOOTING.md#git-merge-conflicts) and consider [beads-merge](https://github.com/neongreen/mono/tree/main/beads-merge) tool.
### Discovered issues in wrong repository ### Discovered issues in wrong repository
@@ -475,13 +475,13 @@ bd create "Issue" -p 1
## Next Steps ## Next Steps
- **CLI Reference:** See [README.md](../README.md) for command details - **CLI Reference:** See [README.md](../README.md) for command details
- **Configuration Guide:** See [CONFIG.md](../CONFIG.md) for all config options - **Configuration Guide:** See [CONFIG.md](CONFIG.md) for all config options
- **Troubleshooting:** See [TROUBLESHOOTING.md](../TROUBLESHOOTING.md) - **Troubleshooting:** See [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
- **Multi-Repo Internals:** See [MULTI_REPO_HYDRATION.md](MULTI_REPO_HYDRATION.md) and [ROUTING.md](ROUTING.md) - **Multi-Repo Internals:** See [MULTI_REPO_HYDRATION.md](MULTI_REPO_HYDRATION.md) and [ROUTING.md](ROUTING.md)
## Related Issues ## Related Issues
- [bd-8rd](/.beads/beads.jsonl#bd-8rd) - Migration and onboarding epic - `bd-8rd` - Migration and onboarding epic
- [bd-mlcz](/.beads/beads.jsonl#bd-mlcz) - `bd migrate` command (planned) - `bd-mlcz` - `bd migrate` command (planned)
- [bd-kla1](/.beads/beads.jsonl#bd-kla1) - `bd init --contributor` wizard ✅ implemented - `bd-kla1` - `bd init --contributor` wizard ✅ implemented
- [bd-twlr](/.beads/beads.jsonl#bd-twlr) - `bd init --team` wizard ✅ implemented - `bd-twlr` - `bd init --team` wizard ✅ implemented

2
docs/QUICKSTART.md
View File

@@ -260,4 +260,4 @@ See [DAEMON.md](DAEMON.md) for complete daemon management guide.
- Search issues: `./bd list --status open` - Search issues: `./bd list --status open`
- Detect cycles: `./bd dep cycles` - Detect cycles: `./bd dep cycles`
See [README.md](README.md) for full documentation. See [README.md](../README.md) for full documentation.

10
docs/RELEASING.md
View File

@@ -12,7 +12,7 @@ Use the fully automated release script:
This does **everything**: version bump, tests, git tag, Homebrew update, and local installation. This does **everything**: version bump, tests, git tag, Homebrew update, and local installation.
See [scripts/README.md](scripts/README.md#releasesh--the-easy-button) for details. See [scripts/README.md](../scripts/README.md#releasesh--the-easy-button) for details.
--- ---
@@ -129,7 +129,7 @@ uv build
TWINE_USERNAME=__token__ TWINE_PASSWORD=pypi-... uv tool run twine upload dist/* TWINE_USERNAME=__token__ TWINE_PASSWORD=pypi-... uv tool run twine upload dist/*
``` ```
See [integrations/beads-mcp/PYPI.md](integrations/beads-mcp/PYPI.md) for detailed PyPI instructions. See [integrations/beads-mcp/PYPI.md](../integrations/beads-mcp/PYPI.md) for detailed PyPI instructions.
### 3. Update Homebrew Formula ### 3. Update Homebrew Formula
@@ -292,6 +292,6 @@ Set up API token at https://pypi.org/manage/account/token/ and use `__token__` a
## Related Documentation ## Related Documentation
- [CHANGELOG.md](CHANGELOG.md) - Release history - [CHANGELOG.md](../CHANGELOG.md) - Release history
- [scripts/README.md](scripts/README.md) - Version bump script details - [scripts/README.md](../scripts/README.md) - Version bump script details
- [integrations/beads-mcp/PYPI.md](integrations/beads-mcp/PYPI.md) - Detailed PyPI guide - [integrations/beads-mcp/PYPI.md](../integrations/beads-mcp/PYPI.md) - Detailed PyPI guide

7
docs/TROUBLESHOOTING.md
View File

@@ -209,7 +209,7 @@ bd config set import.orphan_handling "strict"
- Check for orphans before cleanup: `bd list --id bd-abc.*` - Check for orphans before cleanup: `bd list --id bd-abc.*`
- Review impact before deleting epic/parent issues - Review impact before deleting epic/parent issues
See [docs/CONFIG.md](docs/CONFIG.md#example-import-orphan-handling) for complete configuration documentation. See [CONFIG.md](CONFIG.md#example-import-orphan-handling) for complete configuration documentation.
### Database corruption ### Database corruption
@@ -524,7 +524,7 @@ bd ready
ps aux | grep "bd daemon" ps aux | grep "bd daemon"
``` ```
See [integrations/beads-mcp/README.md](integrations/beads-mcp/README.md) for MCP-specific troubleshooting. See [integrations/beads-mcp/README.md](../integrations/beads-mcp/README.md) for MCP-specific troubleshooting.
### Sandboxed environments (Codex, Claude Code, etc.) ### Sandboxed environments (Codex, Claude Code, etc.)
@@ -718,8 +718,7 @@ If none of these solutions work:
## Related Documentation ## Related Documentation
- **[README.md](README.md)** - Core features and quick start - **[README.md](../README.md)** - Core features and quick start
- **[ADVANCED.md](ADVANCED.md)** - Advanced features - **[ADVANCED.md](ADVANCED.md)** - Advanced features
- **[FAQ.md](FAQ.md)** - Frequently asked questions - **[FAQ.md](FAQ.md)** - Frequently asked questions
- **[INSTALLING.md](INSTALLING.md)** - Installation guide - **[INSTALLING.md](INSTALLING.md)** - Installation guide
- **[ADVANCED.md](ADVANCED.md)** - JSONL format and merge strategies

4
docs/adr/002-agent-mail-integration.md
View File

@@ -220,10 +220,6 @@ Total latency: <100ms (vs 2000-5000ms with git-only)
## References ## References
- [MCP Agent Mail Repository](https://github.com/Dicklesworthstone/mcp_agent_mail) - [MCP Agent Mail Repository](https://github.com/Dicklesworthstone/mcp_agent_mail)
- [bd-spmx Epic](../../.beads/beads.db) - Investigation & Proof of Concept
- [bd-6hji](../../.beads/beads.db) - File Reservation Testing
- [bd-htfk](../../.beads/beads.db) - Latency Benchmarking
- [Latency Results](../../latency_results.md)
## Decision Outcome ## Decision Outcome

2
docs/dev-notes/ERROR_HANDLING_AUDIT.md
View File

@@ -3,7 +3,7 @@
**Issue:** bd-1qwo **Issue:** bd-1qwo
**Scope:** cmd/bd/*.go **Scope:** cmd/bd/*.go
This document audits error handling patterns across the beads CLI codebase to ensure consistency with the guidelines established in [ERROR_HANDLING.md](ERROR_HANDLING.md). This document audits error handling patterns across the beads CLI codebase to ensure consistency with the guidelines established in [ERROR_HANDLING.md](../ERROR_HANDLING.md).
## Executive Summary ## Executive Summary