Repository navigation
Release Update
When a new Bforartists version ships, the manual follows in one pull request per step. Here is the checklist, in order.
flowchart LR
A["π·οΈ Version<br/>and what's new"] --> B["πΈ Screenshots<br/>and workspace maps"]
B --> C["β¨οΈ Keymap<br/>(when automated)"]
C --> D["π§Ή Blender mentions<br/>and summaries"]
D --> E["β
Review<br/>status"]
E --> F["π Publish<br/>live"]
- π·οΈ Version. Update
version:on pages you checked against the new release, andWhat's newinappendix/manual-update-history.md. The Docs home's "What changed" card links there. - πΈ Workspace maps. Re-shoot all workspaces with
ws_capture.pyand import them (Workspace maps). - πΌοΈ Screenshots that changed. Drop new screenshots in Pages CMS; the image bot files them under the same names, so pages need no edit (Images and screenshots).
- β¨οΈ Keymap. Automatic: run Docs 2.0 keymap (Actions) and merge its pull request; add any new keymap to
contexts.ymlif the check asks (Keymap). - π§Ή Clean-up reports.
python3 docs2/tools/cleanup.py --drylists pages that say "Blender" for the program you use;summaries.py --drylists pages without a summary. Fix what they find. - β Checks pass on the pull request (links, images, sidebar, workspace maps).
- π Review status. Reviewers set
status: reviewedon the pages they checked. - π Publish live (below).
Only the lead maintainer does this, once staging looks right.
- Open bforartists.webflow.io/docs/home and click through: a section overview, a workspace page, the keymap, the search (Ctrl K).
- Webflow β Publish β tick bforartists.co (and webflow.io) β Publish.
- Check the same pages on bforartists.co. If anything is wrong, fix it in GitHub and publish again; site scripts can be rolled back in minutes (Site scripts).
The first time only (October 2026): the old /documentation/β¦ pages are drafts in Webflow. Before that first live publish, add the 41 redirects in docs2/reports/webflow-redirects.md (Site settings βΊ Publishing βΊ 301 redirects), so old links and search results land on the new pages. Delete the old pages in the Designer a week or two later.
π 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
- βοΈ 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