BathAfrica:Documentation authoring: Difference between revisions
BathAfrica (talk | contribs) Document shared templates and legacy dependency audit |
BathAfrica (talk | contribs) Update author guidance after completing 159 image uploads |
||
| (One intermediate revision by the same user not shown) | |||
| Line 16: | Line 16: | ||
See [[Template:BathAfrica Key]], [[Template:BathAfrica Button]], and [[Template:BathAfrica Menu]] for usage. | See [[Template:BathAfrica Key]], [[Template:BathAfrica Button]], and [[Template:BathAfrica Menu]] for usage. | ||
== Existing SiteMasterDoc template | == Existing SiteMasterDoc template migration == | ||
All 75 existing source templates and their 150 historical revisions have now been imported. Shared compatibility styles and extension fallbacks are installed. See [[BathAfrica:Template migration]] for the complete status and [[BathAfrica:Legacy template tests]] for the rendering gallery. | |||
All 159 static dependency images have been recovered and preserved, including 155 recovered upstream because they were absent from SiteMasterDoc. All 159 are now installed and registered on this wiki. See [[BathAfrica:Image migration tests]] for the complete image gallery. One historical icon, Workbench_Web.svg, still has a hosting thumbnail-generation limitation; its original SVG is present and opens directly. | |||
== OpenSite source review == | == OpenSite source review == | ||
Latest revision as of 11:09, 29 October 2026
This guide is for documentation authors across BathAfrica products.
Shared page templates
- Template:BathAfrica Command — command identifiers, examples, output, errors, limitations, and verification evidence.
- Template:BathAfrica Feature — behavior, source-reported status, units, hosts, licensing, and evidence.
- Template:BathAfrica Tutorial — prerequisites, steps, expected result, and limitations.
- Template:BathAfrica Workbench — tools, commands, and limitations.
- BathAfrica:Template examples — fictional rendering demonstrations.
Use the optional review parameter to display a review notice. A historical “verified” label is not evidence that the current build was tested.
Inline formatting
- Keyboard key: Ctrl
- Button label:
- Menu path: File → Save
See Template:BathAfrica Key, Template:BathAfrica Button, and Template:BathAfrica Menu for usage.
Existing SiteMasterDoc template migration
All 75 existing source templates and their 150 historical revisions have now been imported. Shared compatibility styles and extension fallbacks are installed. See BathAfrica:Template migration for the complete status and BathAfrica:Legacy template tests for the rendering gallery.
All 159 static dependency images have been recovered and preserved, including 155 recovered upstream because they were absent from SiteMasterDoc. All 159 are now installed and registered on this wiki. See BathAfrica:Image migration tests for the complete image gallery. One historical icon, Workbench_Web.svg, still has a hosting thumbnail-generation limitation; its original SVG is present and opens directly.
OpenSite source review
The uploaded Cursor documentation contains 27 article sources and four template authoring guides. Those guides were not executable rendering templates. The shared templates above implement their fields.
The article sources contain historical claims that need checking against the current repository and build, including GUI availability, expression support, file format version, console availability, and toolchain requirements. Do not publish those claims as current product instructions until checked. The 27 historical articles have not been published as current help.
Use product subpage titles such as OpenSite/Getting started and SiteMaster/Getting started. Keep verified functionality separate from planned features. Record the tested version and reproducible evidence when claiming verification.