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

Add project documentation #19

Open
21 of 23 tasks
ItsDrike opened this issue Jan 13, 2023 · 0 comments · May be fixed by #346
Open
21 of 23 tasks

Add project documentation #19

ItsDrike opened this issue Jan 13, 2023 · 0 comments · May be fixed by #346
Assignees
Labels
a: documentation Related to project's documentation (comments, docstrings, docs) t: feature New request or feature z: large This PR/issue may require making a lot of changes, potentially spanning across multiple PRs
Milestone

Comments

@ItsDrike
Copy link
Member

ItsDrike commented Jan 13, 2023

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]
@ItsDrike ItsDrike added a: documentation Related to project's documentation (comments, docstrings, docs) t: feature New request or feature s: WIP z: large This PR/issue may require making a lot of changes, potentially spanning across multiple PRs labels Jan 13, 2023
@ItsDrike ItsDrike self-assigned this Jan 13, 2023
@ItsDrike ItsDrike added this to the 1.0.0 milestone Jan 13, 2023
@ItsDrike ItsDrike mentioned this issue Jan 13, 2023
4 tasks
This was referenced Feb 16, 2023
@ItsDrike ItsDrike linked a pull request Oct 26, 2024 that will close this issue
47 tasks
@ItsDrike ItsDrike linked a pull request Oct 26, 2024 that will close this issue
47 tasks
@ItsDrike ItsDrike removed the s: WIP label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: documentation Related to project's documentation (comments, docstrings, docs) t: feature New request or feature z: large This PR/issue may require making a lot of changes, potentially spanning across multiple PRs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant