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.

Sign up for GitHub

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

Jump to bottom

Populate the Wiki #12

Open
jon-axon opened this issue Feb 22, 2023 · 0 comments
Open

Populate the Wiki #12

jon-axon opened this issue Feb 22, 2023 · 0 comments
Assignees
@jon-axon
Labels
documentation Improvements or additions to documentation

Comments

@jon-axon
Copy link
Owner

jon-axon commented Feb 22, 2023 •
edited
Loading

In addition to the README and rustdoc html documentation (automatically published here via CI), more general documentation should be produced within the Wiki. This should include, but not necessarily be limited to:

  • Codebase organisation (crates, modules, relationships between structs etc)
  • 3rd party dependencies
  • Fundamental key design/architecture decisions e.g. threading approach
  • Possible future extensions/roadmap
@jon-axon jon-axon added the documentation Improvements or additions to documentation label Feb 22, 2023
@jon-axon jon-axon added this to the v1.0 milestone Feb 22, 2023
@jon-axon jon-axon self-assigned this Feb 22, 2023
@jon-axon jon-axon changed the title Produce comprehensive project documentation (design, user guide etc) Project documentation Feb 22, 2023
@jon-axon jon-axon removed this from the v1.0 milestone Mar 25, 2023
@jon-axon jon-axon changed the title Project documentation Populate the Wiki Mar 29, 2023
@jon-axon jon-axon assigned jon-axon and unassigned jon-axon Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jon-axon jon-axon

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jon-axon