Repository navigation
How Docs 2.0 Works
docs-bot edited this page Oct 26, 2026
·
1 revision
Less work for contributors, more for the reader. No server to run.
π .odt chapters (docs1/) βοΈ Writers
β converter (once per chapter) β Pages CMS Β· GitHub Β· own editor
βΌ βΌ
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β π docs2/ Markdown pages on a GitHub branch β
β content/ snippets/ images/ nav.yml β
βββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ
β every save / pull request
βΌ
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β π€ GitHub Actions β
β πΌοΈ image bot β
checks π preview link β
βββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ
β after review and merge
βΌ
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β π Webflow staging β maintainer's click β live β
β π PDF printed on demand from the website β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
| Piece | What it is | Where |
|---|---|---|
| π Pages | One Markdown file per web page | docs2/content/ |
| β»οΈ Snippets | Sections shared by several pages | docs2/snippets/ |
| πΌοΈ Image library | Every image once, filed by page | docs2/images/ |
| π§ Sidebar | Order and icons of the website sidebar | docs2/nav.yml |
| ποΈ Online editor | Pages CMS, free and open source, nothing to host | .pages.yml |
| βοΈ Tools | Converter, checks, image bot, preview, sync | docs2/tools/ |
| π€ Automation | Runs the tools on every change | .github/workflows/docs2.yml |
| π Website | Webflow CMS: Doc Sections, Doc Pages, Doc Snippets | bforartists.webflow.io (staging) |
| # | Rule |
|---|---|
| 1 | π§° Writers install nothing |
| 2 | βοΈ Pages contain no special codes (Plain writing) |
| 3 | π Nothing is trimmed or reworded until the whole manual is migrated and live |
| 4 | π¦ The .odt manual is archived in docs1/; Docs 2.0 on master is the official manual |
| 5 | π Nothing reaches the live website without a maintainer's click |
π Bforartists Manual wiki Β· GPL v3 Β· Repository Β· Website Β· Report a docs problem Β· These pages are kept in docs2/dev-docs/ and copied here, so edit them there.
π Home
βοΈ Writing
- π Writer quick start
- βοΈ Editing the docs online
- βοΈ Plain writing
- πΌοΈ Images and screenshots
- π Formatting standard
- β»οΈ Shared sections
- π Reference Manual writing guide
βοΈ How it works
- πΊοΈ How Docs 2.0 works
- πΏ Branches and review
- π Converting chapters
- β Checks and previews
- π Website sync
π§° Maintaining
- π§° Maintainer guide
- π§ Structure and navigation
- πΊοΈ Workspace maps
- β¨οΈ Keymap
- ποΈ Site scripts
- π Release update
- π©Ί Troubleshooting
π Status