Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor docs #193

Open
5 of 6 tasks
steph1111 opened this issue Jan 17, 2024 · 0 comments
Open
5 of 6 tasks

Refactor docs #193

steph1111 opened this issue Jan 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@steph1111
Copy link
Member

steph1111 commented Jan 17, 2024

The current docs are outdated and should be updated for the new code

  • Create code of conduct
  • Create PR guide: guides for the requester and reviewer (look at the missing readme book for inspiration)
  • Project style guidelines
  • Upload image of controller mapping
  • Update existing docs and make them easier to find/navigate
  • Architecture doc which describes each node and its purpose and organization of the software
@steph1111 steph1111 added the documentation Improvements or additions to documentation label Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant