generated from eblume/project-template
Erich Blume
cbf859b2d7
Some checks failed
Build / validate (push) Failing after 2s
Customize the generated repo (rename Dagger module to hephaestus_ci /
HephaestusCi, set docs baseUrl, add All-Rights-Reserved LICENSE, update
README/AGENTS), and add the project's foundational design documentation:
- docs/explanation/design.md — rationale + decision-history record
- docs/reference/tech-spec.md — implementation-ready technical spec
These define hephaestus as a self-hosted, client/server + offline-first
system unifying a markdown knowledge base with task management: typed node
graph, the lived priority discipline ("what is next?"), recurrence with
fresh-per-occurrence checklists, op-log/CRDT sync with conflict resolution,
OIDC/Authentik auth, the heph.nvim surface, and a TDD strategy.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
45 lines
2 KiB
Markdown
45 lines
2 KiB
Markdown
# hephaestus
|
|
|
|
A personal context management system — a unified, self-hosted application that fuses a wiki-style knowledge base (Zettelkasten) with task management. Built in Rust, offline-capable, and syncs to a central instance hosted in blumeops.
|
|
|
|
See [the project design document](docs/explanation/design.md) for goals, architecture, and the development roadmap.
|
|
|
|
## What's Included
|
|
|
|
- **Documentation** — [Diataxis](https://diataxis.fr/)-structured docs built with [Quartz](https://quartz.jzhao.xyz/)
|
|
- **Changelog** — [Towncrier](https://towncrier.readthedocs.io/) fragment-based changelog
|
|
- **CI/CD** — [Dagger](https://dagger.io/) pipelines + Forgejo `build` and `release` workflows
|
|
- **Pre-commit hooks** — [prek](https://github.com/dustinblackman/prek) with linting, formatting, secret detection
|
|
- **AI assistance** — `AGENTS.md` + structured docs for Claude Code (C0/C1/C2 change process, Mikado method)
|
|
- **Task runner** — [mise](https://mise.jdx.dev/) tasks for docs validation, Mikado chain management, release preview, and runner inspection
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
# Install git hooks
|
|
prek install && prek install --hook-type commit-msg
|
|
|
|
# Run all pre-commit checks
|
|
prek run --all-files
|
|
|
|
# List available tasks
|
|
mise tasks
|
|
|
|
# Build docs (requires Dagger)
|
|
dagger call build-docs --src=. --version=dev export --path=./docs-dev.tar.gz
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
./docs/ # documentation (Diataxis, Quartz)
|
|
./docs/changelog.d/ # leave only .gitkeep in the template; generated repos add towncrier fragments here
|
|
./.dagger/ # Dagger module backing docs builds and releases
|
|
./.forgejo/workflows/ # generic build/release workflows for generated repos
|
|
./.forgejo/scripts/ # optional per-project hooks consumed by those workflows
|
|
./mise-tasks/ # scripts via `mise run`
|
|
```
|
|
|
|
## License
|
|
|
|
All rights reserved. This is a personal, private project — not licensed for use, copying, modification, or distribution. Open-sourcing may be considered in the future. See [LICENSE](LICENSE).
|