fix/doc: Go version inconsistencies and broken documentation links (#535)
* docs: fix Go version typo in CONTRIBUTING.md (1.25 -> 1.24) * docs: update Go version requirement to 1.24+ across docs * docs: fix broken links to docs/ in npm-package/README.md * docs: fix QUICKSTART.md path reference in AGENTS.md
This commit is contained in:
@@ -526,7 +526,7 @@ bd show bd-41 --json # Verify merged content
|
||||
|
||||
**Quick reference:**
|
||||
|
||||
- **Go version**: 1.21+
|
||||
- **Go version**: 1.24+
|
||||
- **Testing**: Use `BEADS_DB=/tmp/test.db` to avoid polluting production database
|
||||
- **Before committing**: Run tests (`go test -short ./...`) and linter (`golangci-lint run ./...`)
|
||||
- **End of session**: Always run `bd sync` to flush/commit/push changes
|
||||
@@ -749,6 +749,6 @@ history/
|
||||
- ❌ Do NOT duplicate tracking systems
|
||||
- ❌ Do NOT clutter repo root with planning documents
|
||||
|
||||
For more details, see README.md and QUICKSTART.md.
|
||||
For more details, see README.md and docs/QUICKSTART.md.
|
||||
|
||||
<!-- /bd onboard section -->
|
||||
|
||||
@@ -8,7 +8,7 @@ This document contains detailed operational instructions for AI agents working o
|
||||
|
||||
### Code Standards
|
||||
|
||||
- **Go version**: 1.21+
|
||||
- **Go version**: 1.24+
|
||||
- **Linting**: `golangci-lint run ./...` (baseline warnings documented in [docs/LINTING.md](docs/LINTING.md))
|
||||
- **Testing**: All new features need tests (`go test -short ./...` for local, full tests run in CI)
|
||||
- **Documentation**: Update relevant .md files
|
||||
|
||||
@@ -6,7 +6,7 @@ Thank you for your interest in contributing to bd! This document provides guidel
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.25 or later
|
||||
- Go 1.24 or later
|
||||
- Git
|
||||
- (Optional) golangci-lint for local linting
|
||||
|
||||
|
||||
@@ -164,7 +164,7 @@ During `git merge`, beads-merge:
|
||||
**If you prefer the standalone binary (same algorithm):**
|
||||
|
||||
```bash
|
||||
# Install (requires Go 1.21+)
|
||||
# Install (requires Go 1.24+)
|
||||
git clone https://github.com/neongreen/mono.git
|
||||
cd mono/beads-merge
|
||||
go install
|
||||
|
||||
@@ -59,7 +59,7 @@ GROUP BY i.id, e.id
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.21 or later
|
||||
- Go 1.24 or later
|
||||
- bd initialized in a directory (run `bd init --prefix demo`)
|
||||
|
||||
### Install
|
||||
|
||||
@@ -100,10 +100,10 @@ This package downloads the appropriate native binary for your platform:
|
||||
For complete documentation, see the [beads GitHub repository](https://github.com/steveyegge/beads):
|
||||
|
||||
- [Complete README](https://github.com/steveyegge/beads#readme)
|
||||
- [Quick Start Guide](https://github.com/steveyegge/beads/blob/main/QUICKSTART.md)
|
||||
- [Installation Guide](https://github.com/steveyegge/beads/blob/main/INSTALLING.md)
|
||||
- [FAQ](https://github.com/steveyegge/beads/blob/main/FAQ.md)
|
||||
- [Troubleshooting](https://github.com/steveyegge/beads/blob/main/TROUBLESHOOTING.md)
|
||||
- [Quick Start Guide](https://github.com/steveyegge/beads/blob/main/docs/QUICKSTART.md)
|
||||
- [Installation Guide](https://github.com/steveyegge/beads/blob/main/docs/INSTALLING.md)
|
||||
- [FAQ](https://github.com/steveyegge/beads/blob/main/docs/FAQ.md)
|
||||
- [Troubleshooting](https://github.com/steveyegge/beads/blob/main/docs/TROUBLESHOOTING.md)
|
||||
|
||||
## Why npm Package vs WASM?
|
||||
|
||||
|
||||
Reference in New Issue
Block a user