Skip to content

Commit bd07eba

Browse files
committed
docs: fix version badge link and add version bump checklist to CLAUDE.md
Signed-off-by: Drew Cain <groksrc@gmail.com>
1 parent 3eb1e86 commit bd07eba

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

CLAUDE.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,15 +170,24 @@ pip install basic-memory
170170
- Docus configuration in `app/app.config.ts`
171171
- LLM-friendly output via nuxt-llms module
172172

173+
## Version Bump Checklist
174+
175+
When updating docs for a new Basic Memory release, update all of the following:
176+
177+
1. **Homepage version badge**`content/index.md`: update the version text (e.g., `v0.20 →`) and the `to:` link to point to the new release notes page
178+
2. **Release notes page**`content/2.whats-new/0.v<VERSION>.md`: rename and update with new release content (the `0.` prefix keeps it first in the nav)
179+
3. **Changelog**`content/2.whats-new/2.changelog.md` auto-fetches from GitHub releases API, no manual update needed
180+
4. **Deploy** — push to main auto-deploys to development; production requires manual workflow dispatch via GitHub Actions
181+
173182
## Documentation Status & Priorities
174183

175-
Documentation is up-to-date for v0.19.x release. Cloud product documentation is complete.
184+
Documentation is up-to-date for v0.20.x release. Cloud product documentation is complete.
176185

177186
### Reference Materials
178187

179188
When documenting features:
180189
- **Basic Memory CHANGELOG**: `gh api repos/basicmachines-co/basic-memory/contents/CHANGELOG.md`
181-
- **Release Notes**: `gh release view v0.19.0 --repo basicmachines-co/basic-memory`
190+
- **Release Notes**: `gh release view v0.20.0 --repo basicmachines-co/basic-memory`
182191
- **Basic Memory README**: https://github.com/basicmachines-co/basic-memory
183192
- **Cloud README**: https://github.com/basicmachines-co/basic-memory-cloud
184193
- **Cloud CLAUDE.md**: https://github.com/basicmachines-co/basic-memory-cloud/blob/main/CLAUDE.md

content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ See why your AI needs Basic Memory.
4444
:::u-button
4545
---
4646
size: sm
47-
to: https://basicmemory.com
47+
to: /whats-new/v0.20.0
4848
variant: outline
4949
---
5050
v0.20 →

0 commit comments

Comments
 (0)