Repository navigation
0011 docs and wiki
github-actions[bot] edited this page Nov 17, 2026
·
3 revisions
Status: accepted · Implementation: done · Date: 2026-11-17
Built: scripts/wiki.ts and the workflow. First publish 2026-11-17: 15 pages, a sidebar and a footer, identical to the local build. Since ADR 0012 the wiki is published on pushes to dev, not main.
LibreLifts has two kinds of reader. People who want the app need to know what it does; that
is the website's job (ADR 0009). People who work on it need the scope, the decisions and how
to run it. Those documents live in docs/, reviewed and versioned with the code, but a folder
of Markdown files is awkward to browse.
-
docs/is developer documentation: the parity plan, the decision records and how to set up and run the project. Material for users goes on the website. docs/is the only place the docs are edited.-
The GitHub wiki is a generated mirror of
docs/.scripts/wiki.tsturns the folder into wiki pages, with links rewritten, a sidebar, and each record's frontmatter shown as a status line..github/workflows/wiki.ymlpublishes it on every push tomainthat touches the docs. - The script fails on a link between docs that doesn't resolve, so publishing is also the link check.
- The docs can be browsed and searched on the wiki, and still change through commits.
- An edit made on the wiki in the browser is overwritten by the next publish.
- Wiki commits are made by the GitHub Actions bot in the wiki's own repository. They are not signed and are not part of the project's history.
- The wiki has to exist before the workflow can push to it: its first page is created by hand, once.
Generated from docs/ on dev. Edit the docs there; changes made on the wiki are overwritten.
- The open database and the API
- Development
- Parity with StrongLifts
- Workflow
-
Decisions
- 0001 Decisions are recorded as ADRs
- 0002 Apache License 2.0
- 0003 Parity with StrongLifts, everything free
- 0004 iOS, Android and web
- 0005 Local-first; accounts and sync later through Spotcraft
- 0006 openweight for import and export, not for storage
- 0007 One Expo app, wrapped in Electron for desktop
- 0008 A pnpm workspace with app, desktop and core
- 0009 The website is static Astro in apps/website
- 0010 The website is hosted on GitHub Pages at librelifts.app
- 0011 docs/ is for developers and is mirrored to the wiki
- 0012 Changes land on dev by fast-forward; main is the last release
- 0013 LibreLifts is an app and a crowd-sourced open database
- 0014 The database is ODbL, media is CC BY-SA, and neither can be closed later
- 0015 Data contributions start as pull requests; a web editor comes later
- 0016 A hosted API with a free tier is the paid product