Move zk cards to docs/zk/ for documentation restructuring #84

Merged
eblume merged 12 commits from feature/docs-restructure-phase1 into main 2026-02-03 09:13:51 -08:00

12 commits

Author SHA1 Message Date
3ba211cf26 Check for existing release before building
Fail early with clear error if the specified version already exists.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 09:11:27 -08:00
b45e2cb862 Add auto-increment patch version to build workflow
Leave version input empty to auto-increment patch (v_._.+1) from the
latest release. First release starts at v1.0.0.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 09:10:18 -08:00
9b87542cae Remove Quartz caching, rebuild every time
Simpler is better - just clone and npm ci on each build.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 09:04:47 -08:00
e626425d34 Simplify Quartz cache key naming
Use quartz-1, quartz-2, etc. for cache invalidation. The actual Quartz
version is determined by the mirror repo, not this key.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 09:03:53 -08:00
3e6245da28 Add caching for Quartz setup in build workflow
Cache the Quartz clone and node_modules to speed up subsequent builds.
Only the content copy and build steps run on cache hit.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 09:01:48 -08:00
456296a990 Use local Quartz mirror instead of GitHub
Clone from forge.ops.eblu.me to avoid external dependencies during builds.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:58:09 -08:00
b3b0e110c8 Add docs/index.md instead of generating in workflow
Keep the index page as a normal doc file that can be edited,
rather than generating it during the build workflow.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:52:13 -08:00
fe161e547c Move Quartz config files to docs/
Keep repo root cleaner by storing quartz.config.ts and quartz.layout.ts
in docs/ alongside the content they configure. Updated workflow to copy
from the new location.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:40:21 -08:00
0080d1c54a Add Quartz documentation build infrastructure
Phase 1a infrastructure for building and hosting BlumeOps docs:

- Add quartz.config.ts and quartz.layout.ts for Quartz configuration
- Add containers/quartz/ with nginx-based static site server that
  downloads release bundles on startup via DOCS_RELEASE_URL env var
- Add .forgejo/workflows/build-blumeops.yaml workflow (manual trigger)
  that builds Quartz site and creates Forgejo release with tarball
- Update docs/README.md with finalized tooling choice and split
  Phase 1 into 1a (CI) and 1b (CD/hosting)

The architecture separates content versioning from infrastructure:
- Releases are versioned BlumeOps releases (v1.0.0, etc.)
- Doc tarballs are attached as release assets
- The quartz container is a generic static site server

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:38:12 -08:00
38dae76cb9 Expand docs/README.md with full restructuring plan
Add comprehensive phased plan for documentation restructuring:
- Phase 1: Foundation (current) - zk migration, tooling selection
- Phase 2: Tutorials - learning-oriented content
- Phase 3: How-to Guides - task-oriented instructions
- Phase 4: Reference - technical descriptions
- Phase 5: Explanation - concepts and decisions
- Phase 6: Integration & Cleanup

Also includes:
- Tooling evaluation table (Quartz, MkDocs, mdBook, Hugo, Docusaurus)
- Requirements (Obsidian compatibility, wiki-links, HTML/PDF output)
- Note on project naming (BlumeOps / blumeops / Blue Mops)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:08:46 -08:00
fb8f98a47d Update main README to reflect docs restructuring
Point to docs/README.md for the restructuring plan and clarify that
zk cards now live in docs/zk/.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 08:02:36 -08:00
7112297150 Move zk cards to docs/zk/ for documentation restructuring
Phase 1 of docs restructuring: move all zettelkasten cards to a
temporary docs/zk/ subdirectory while preparing to build a new
Diataxis-based documentation structure.

- Move all existing markdown files from docs/ to docs/zk/
- Update zk-docs mise task to look in the new location
- Add docs/README.md explaining the restructuring plan

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-03 07:57:47 -08:00