We are still months away from a production deployment, but we should start working on the basic scaffolding for end user help documentation. We can and should put short tips into the UI as translatable strings, but more full featured help documentation will be easier to maintain on metawiki. Using the wiki will allow Extension:Translate usage for making the documentation more accessible. It will also allow the user community to contribute to the documentation much more easily than in-app help storage would.
Description
Description
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | bd808 | T275907 Start creating end-user help for Toolhub on meta | |||
| Duplicate | None | T275805 Document how to get OpenAPI spec in JSON format | |||
| Open | None | T274679 Document using /api/schema/ for code generation/api use |
Event Timeline
Comment Actions
@srishakatux, @srodlund, and @apaskulin: Any tips, tricks, ideas, or templates that y'all have for starting a green field collection of application + api usage docs would be appreciated!
I hope we can actually rely on the software generated OpenAPI schema for the details of the inputs and outputs of individual API endpoints, but that will not fill the need for more general docs on why and how to use the API system.
On the UI side, complex features like the faced search engine will need a place for documentation as well.
Comment Actions
I talked about this topic with @srodlund and @apaskulin in their tech doc office hour today. @apaskulin shared https://www.mediawiki.org/wiki/Selenium as an organization method that seems to work pretty well.