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.
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
Use a runtime like Nextra for porting existing README information to more scalable and "nicer looking" documentation page
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.
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.
Overhaul the documentation structure of Oakestra webpage.
Use a runtime like Nextra for porting existing README information to more scalable and "nicer looking" documentation page
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