eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Update docs/README.md: Phase 1a complete, prep for 1b

Browse source 
Mark Phase 1a as complete with link to first release.
Move CHANGELOG to Phase 1b with towncrier note.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Erich Blume 2026-02-03 10:16:24 -08:00
commit a1044a8c4a
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/README.md
View file

@ -41,7 +41,7 @@ The documentation is being restructured to follow the [Diataxis](https://diataxi
## Restructuring Phases
### Phase 1a: Foundation & CI (Current)
### Phase 1a: Foundation & CI (Complete)
- [x] Move existing zk cards to `docs/zk/`
- [x] Update `zk-docs` mise task for new path
- [x] Create this README with restructuring plan
@ -49,14 +49,20 @@ The documentation is being restructured to follow the [Diataxis](https://diataxi
- [x] Create Quartz configuration (`quartz.config.ts`, `quartz.layout.ts`)
- [x] Create `quartz` container for serving static sites
- [x] Create `build-blumeops` workflow for building releases
- [ ] Test the build workflow and verify release creation
- [ ] Create `CHANGELOG.md`
- [x] Test the build workflow and verify release creation (v1.0.0)
### Phase 1b: CD & Hosting
**First release:** [v1.0.0](https://forge.ops.eblu.me/eblume/blumeops/releases/tag/v1.0.0)
### Phase 1b: CD & Hosting (Current)
- [ ] Build and tag `quartz` container (`mise run container-tag-and-release quartz v1.0.0`)
- [ ] Create ArgoCD manifests for `quartz` deployment
- [ ] Add `docs.ops.eblu.me` to Caddy reverse proxy
- [ ] Configure deployment to pull from release URL
- [ ] Configure deployment with `DOCS_RELEASE_URL`:
```
https://forge.ops.eblu.me/eblume/blumeops/releases/download/v1.0.0/docs-v1.0.0.tar.gz
```
- [ ] Test end-to-end: commit -> build -> release -> deploy
- [ ] Set up `CHANGELOG.md` with [towncrier](https://towncrier.readthedocs.io/) using news fragments from zk cards
### Phase 2: Tutorials
Learning-oriented content for getting started.