Skip to content

How Docs 2.0 Works

docs-bot edited this page Oct 26, 2026 · 1 revision

πŸ—ΊοΈ How Docs 2.0 works

Less work for contributors, more for the reader. No server to run.


πŸ›£οΈ The road a page travels

  πŸ“„ .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          β”‚
  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

🧱 Pieces

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)

πŸ“ Rules we keep

# 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

Clone this wiki locally