Home

Bforartists Manual Wiki

Writing, building and publishing the Bforartists manual

This wiki is for writers, reviewers and maintainers of the Bforartists manual. For the manual itself, see the Bforartists documentation.

---

🧭 The manual, then and now

	📦 Before: the .odt manual (archived)	✅ Now: Docs 2.0
Where	.odt chapters in docs1/	Markdown pages in docs2/ on the master branch
Edit with	LibreOffice	Your browser (Pages CMS), GitHub, or any editor
Published as	PDF and website pages copied by hand	The website, synced from GitHub; PDF printed on demand
Guide	📘 Reference Manual writing guide	✏️ Editing the docs online
Status	📦 Archived, kept for reference	✅ The official manual since October 2026 (332 pages); review and polish under way

💡 New here? Start with the Writer quick start. It takes five minutes and you need nothing installed. Editing the docs online has the details.

---

🚀 Quick Links

Section	Start here
✏️ Editing the docs online	Fix or write a page in your browser
✍️ Plain writing	What you type, and what the website shows
🖼️ Images and screenshots	Drop a screenshot in; the bot files it
🌿 Branches and review	How a change travels from your save to the website
🛣️ Roadmap	What is done, what is next
🧰 Maintainer guide	Every maintenance job, step by step

---

📖 Wiki Contents

✏️ Writing

Page	Description
✏️ Editing the docs online	Pages CMS, the GitHub editor or your own editor: which to pick, step by step
✍️ Plain writing	Tips, keys, menu paths, images and videos with no special codes
🖼️ Images and screenshots	Dropping, naming, sizes and the image library
♻️ Shared sections	Write a section once, show it on every page that needs it
📘 Reference Manual writing guide	What a manual entry contains, and what it leaves out

⚙️ How it works

Page	Description
🗺️ How Docs 2.0 works	The road a page travels: GitHub → checks → website
🌿 Branches and review	Branches, pull requests and who approves what
🔄 Converting chapters	Turning .odt chapters into pages without losing a word
✅ Checks and previews	What every change is checked for, and the preview link
🌐 Website sync	How a merge reaches the staging website

🧰 Maintaining

Page	Description
🧰 Maintainer guide	The whole system on one picture, "I want to…", roles and rhythm
🧭 Structure and navigation	Add, move or remove pages; the Docs home; page status; search
🗺️ Workspace maps	Edit what an area says; re-shoot the workspaces each release
🎛️ Site scripts	Change, version, register and roll back the website's docs scripts
🚀 Release update	The checklist for a new Bforartists version, and publishing live
🩺 Troubleshooting	A page did not update, checks failed, something looks broken

📊 Status

Page	Description
🛣️ Roadmap	Phases, decisions and what comes next

---

📊 Quick Stats

Metric	Value
📄 Pages in Docs 2.0	332, in 9 sections
✅ Words kept from the .odt	Every chapter converted with its words (about 764,000)
🖼️ Images in the library	About 12,400, each stored once
🗺️ Workspace maps	18 workspaces, 106 areas
🧰 Tools to install for writers	0

---

Support Links

Reference Manual (PDF)

https://www.bforartists.de/bforartists-2-reference-manual/

Developer Wiki

https://github.com/Bforartists/Bforartists/wiki

Get Involved

https://www.bforartists.de/get-involved/