Page MenuHomePhabricator

[WBS Doc] WBS Documentation
Open, Stalled, MediumPublic

Description

As a user, I would like to have a dedicated place to read WBS documentation matching the version of a product I am currently using.

Current Situation:

  • Users are browsing documentation directly in our source code tree
  • Users need to manually select branches and tags in the repo to access documentation matching their version

Goal:

  • Create a site hosting WBS documentation, for all the products and versions currently supported

Acceptance Criteria:

  • Documentation site published
  • Process of adding new versions to the site is automated (connected to release/publish workflow)

[optional] Notes:

  • There is docusaurus (React) and vuepress (vue)
  • Docusaurus supports versions and products, vuepress: TBD

[optional] Open Questions:

  • Consider the purpose and the audience of the DOCS folder. Then change it accordingly

Event Timeline

As a user, I would like to have a dedicated place to read WBS documentation matching the version of a product I am currently using.

Also, as a user I would like to find this information in my running instance or, at least, the external links matching the version running.

Leif_WMDE renamed this task from Documentation site to WBS Documentation.Jun 11 2025, 7:46 AM
Leif_WMDE added a project: Epic.
Leif_WMDE moved this task from Doing to Sprint Backlog on the Wikibase Suite Team (Sprint-∞) board.
Leif_WMDE changed the status of subtask T396558: [WBS Doc] Define SSOT documentation from Open to In Progress.

As a user, I would like to have a dedicated place to read WBS documentation matching the version of a product I am currently using.

Also, as a user I would like to find this information in my running instance or, at least, the external links matching the version running.

For some features, it would indeed be very nice to include documentation of various things along side the things that we being used.
I believe the existing pattern instead is that there are some links to wikidata for such topics?

Leif_WMDE renamed this task from WBS Documentation to [WBS Doc] WBS Documentation.Jun 11 2025, 8:20 AM
Leif_WMDE triaged this task as Medium priority.Aug 15 2025, 4:13 PM