Skip to content

Add project documentation #19

@ItsDrike

Description

@ItsDrike

The project should have an easily accessible and readable documentation, where it's explicitly state what is or isn't a part of the public API, and hence where the backwards compatibility will be ensured, including a few reference examples, and anything else that could be useful for the users, but also for contributors.

To keep track of everything from a single place, this issue should be linked in involved PRs, and below is the list of all features that need to be done before this issue can be marked as resolved:


  • Rewrite the docs using mkdocs, alongside fulfilling a bunch of other points: [DONE: Move to mkdocs #346]

Metadata

Metadata

Assignees

Labels

a: documentationRelated to project's documentation (comments, docstrings, docs)s: staleHas had no activity for a while (will be closed for inactivity/marked up for grabs soon)t: featureNew request or featurez: largeThis PR/issue may require making a lot of changes, potentially spanning across multiple PRs

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions