/
Documentation Roadmap

Documentation Roadmap

  • Standardize `open-horizon-services` Makefile targets, issue and PR templates, documentation, and GHAs

    • The makefile targets should be based on this exemplar using this information

    • This effort will be based in the Examples Working Group (EWG), not the Documentation Working Group (DWG)

  • Collect all documentation best practices into one place (Wiki) and begin disseminating (volunteer on-boarding, etc)

  • Collect all repo-specific developer documentation into the main documentation web site

  • Create and build out the project (marketing) web site on provided WordPress platform

    • Apply Carbon Design System to a WordPress Theme

    • Identify sections and pages for the site and begin building

  • Create new documentation sections and pages to address gaps

    • One way to identify gaps is by looking at the orphan pages

    • Also, we need to identify the various "journeys" (app dev, model dev, admin, operator, etc) and map out how they would use the documentation

Related content

2023-12-06 Meeting notes for Documentation Working Group
2023-12-06 Meeting notes for Documentation Working Group
More like this
2024-03-27 Meeting notes for Documentation Working Group
2024-03-27 Meeting notes for Documentation Working Group
More like this
Documentation Working Group
Documentation Working Group
More like this
Project Governance
Project Governance
More like this
2022-12-13 Meeting notes
2022-12-13 Meeting notes
More like this
Meeting Agenda - 2021-10-12
Meeting Agenda - 2021-10-12
More like this