Skip to content

1.0.0 RAFT Documentation

Closed Apr 30, 2024 100% complete

Moving the project to be released open source requires the following basic documentation to be generated:

  • A README.md files with an overview and links to other documentation for the project
  • Licensing and Contributing files
  • A "Getting Started" guide to allow new users to use the code
  • All code needs docstrings to document what each function and class does
  • A…

Moving the project to be released open source requires the following basic documentation to be generated:

  • A README.md files with an overview and links to other documentation for the project
  • Licensing and Contributing files
  • A "Getting Started" guide to allow new users to use the code
  • All code needs docstrings to document what each function and class does
  • All interfaces need documenting, so a user can understand and use them
  • An overall architecture document needs to be produced to show how the framework fits together

This milestone is closed.

No open issues remain. View closed issues or see open milestones in this repository.