search

oakestra / documentation

The front page and documentation for the Oakestra Project.
https://oakestra.io
0 stars 2 forks source link

Create new documentation page style #13

Open nitindermohan opened 7 months ago

nitindermohan commented 7 months ago

Short

Within the discussion to move the code READMEs to website, we need a new documentation page style guideline which is standardized to use and easy for devs to push their code READMEs in.

Proposal

The intended structure can be as follows.

  1. Overhaul the documentation structure of Oakestra webpage.

    • Bring publications to documentation
    • create a clear getting started guide
    • create a feature set guide which brings the content from publications
    • Add support for release blogs
    • Add version support for docs

  2. Use a runtime like Nextra for porting existing README information to more scalable and "nicer looking" documentation page

  3. Maybe overhaul the Wiki UI with components like Chakra UI to make wiki inviting and easy to navigate.

Development time

Around 1-2 months.

Status

More ideas on how to structure the documentation build are welcome.

Checklist

nitindermohan commented 5 months ago

Overhauled the comment and added more details. @giobart @TheDarkPyotr I am adding you as reviewers for this work.

nitindermohan commented 4 weeks ago

Implementation is ongoing but it has clearly exceeded the estimated 1-2 month time period