Repository navigation
Troubleshooting
The usual surprises, what causes them and the fix. Start with the job summary: Actions β the latest "Docs 2.0 checks and preview" run β Summary.
flowchart TD
Q{"What's wrong?"} --> A["A page did not update"]
Q --> B["Checks failed"]
Q --> C["Something looks broken<br/>on the website"]
Q --> D["The sidebar or search<br/>is out of date"]
A --> A1["Job summary shows β?<br/>β edited in Webflow"]
B --> B1["Read the pull request comment<br/>β fix the file it names"]
C --> C1["Script failed to load?<br/>β hash or version"]
D --> D1["Old copy in the browser<br/>β reload, it refreshes itself"]
| You see | Cause | Fix |
|---|---|---|
| β "edited by hand in Webflow after the last sync; skipped" in the job summary | Someone changed the item in the Webflow CMS or Designer, so the sync leaves it alone rather than overwrite their work | Copy anything worth keeping into GitHub. Then, in the Webflow CMS, set the item's Checksum field to `reset |
| βοΈ "unchanged" | Nothing in the built page changed | Check that your change was merged into master, not just a branch |
| The page is updated in the CMS but not on the site | Staging was not published | Webflow β Publish β webflow.io, or re-run the workflow |
The pull request comment lists each problem with its file and line. The common ones:
| Check | Usually means |
|---|---|
| π Links | A link points to a page that moved; update the link |
| πΌοΈ Images | A picture's file name changed; re-drop it or fix the path |
| π§ Sidebar |
nav.yml lists a file that was moved or deleted |
| πΊοΈ Workspace maps |
workspaces.yml names an editor not in editors:, or a screenshot that is missing |
| π Unique IDs | Two pages have the same id; give the new one its own |
| You see | Cause | Fix |
|---|---|---|
| Plain lists instead of cards or maps | A site script did not load. In the browser console: "Failed to find a valid digest" | The registered hash does not match the file: register the version again with the hash from the job summary (Site scripts) |
| A new feature is missing | The template still uses the old version | Apply the new version to the template and publish staging |
| The workspace picker is missing on the Docs home | The template runs the docs layer before the workspace map script (an update moved it to the end) | Put bfa_workspace_map before bfa_docs_layer and publish (Site scripts); docs layer 1.0.9 and later copes with either order |
| A workspace map is in the wrong place | The screenshot changed but the boxes did not | Re-capture or run ws_map.py detect <workspace> (Workspace maps) |
The website keeps a copy of the sidebar in the browser for speed and checks for a newer one on every visit, so a second reload shows the change. If not, check that the workflow's "Publish the sidebar" step ran: it writes nav.json and search.json to GitHub Pages.
Ask in the Bforartists Discord, or open an issue in Bforartists/Manual with the link to the job summary.
π 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