Intro

The target of this conspiracy to make Anuket more easy to understand for someone who is not involved in the project.

We would like to achieve this by tuning the already existing documentation created for the project. This includes applying consistent templates, linking the documents together in a meaningful way and many more listed in here.

This page is created to help the conspirators.

Current conspirators

• Gergely Csatari 
• Georg Kunz 
• Scot Steele 
• Beth Cohen 

Project management and communication

• GitHub project: https://github.com/cntt-n/CNTT/projects/34#card-85674686
• Meetings: we do not have a dedicated meeting, but use the Anuket Weekly Technical Discussions to discuss
• Communication: the common denominator is sending an email to the Current conspirators. If the issue is relevant for wider audience use the anuket-tech-discuss dl.

What is where

Things to do

• Rearchitect the docs repository structure.
• Think about the redirects
  • create specs.anuket.io
• Use the same theme in all documents
  • Think about using a different theme instead of material (https://sphinx-themes.org/)
• Anuket Landing page
  • A picture explaining the different type of projects
  • Explain what the different parts are doing
• Cleanup not needed files and directories
• Specs landing page
  • Explain what the different specs are specifying
• Documentation guide
  • Linting recommendations
  • Used language
  • An actual guide how to contribute