mycoach documentation¶
An OKF
knowledge bundle: every page below is a concept document with YAML frontmatter
(a required type, plus title / description / tags). Links are
bundle-relative. See log.md for the change history.
Product features¶
See features/ for the per-feature concept documents.
- Example feature — replace with your own.
Features
Product features¶
Each entry is an OKF concept document (type: Product Feature) grounded in the
source. Group them in the mkdocs.yml nav as the set grows (e.g. Guest-facing /
Owner-operations / Cross-cutting).
- Example feature — replace with your own.
Example feature¶
Copy this page for each real feature (docs/features/<slug>.md) and delete this
one. Ground every statement in real code and link the resource: to the primary
source file.
launched: and release: render as the badge under the title. For a new
feature, leave them off — the Publish Docs pipeline stamps them on the first prod
merge and cuts the next release.
How it works¶
- Describe the flow in a few grounded bullet points.
- Add a diagram for anything non-trivial (rendered by
mkdocs-mermaid2-plugin):
Related¶
Release notes¶
Product releases, newest first. Each version bundles the features promoted to
production in one batch. Maintained automatically by the Publish Docs
pipeline on merge to master (scripts/release_stamp.py) — on a prod merge it
stamps launch dates on newly-published feature docs and prepends the next
release section here.
0.1.0 — Initial¶
- Example feature — replace with your product's features. · details
Documentation Update Log¶
Newest first. Add a dated ## YYYY-MM-DD entry whenever docs change.
0.0.0 — Bootstrapped from repo-template¶
- Created the docs site from the uFactor
docs-hub/repo-templatestarter.