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

Documentation Rewrite #4

Open
Krytic opened this issue Jun 2, 2020 · 1 comment
Open

Documentation Rewrite #4

Krytic opened this issue Jun 2, 2020 · 1 comment
Assignees
@Krytic
Labels
documentation Improvements or additions to documentation priority:medium
Projects
Enhancements
Milestone
v1.0.0

Comments

@Krytic
Copy link
Owner

Krytic commented Jun 2, 2020

The current documentation is not good. It is an API documentation which will be useful, however there is no formal documentation detailing philosophy behind code, or walking users through the paradigms we employ.

This issue is to reflect work already in progress on the documentation branch.
@Krytic Krytic self-assigned this Jun 2, 2020
@Krytic Krytic added this to To do in Enhancements via automation Jun 2, 2020
@Krytic Krytic added documentation Improvements or additions to documentation priority:medium labels Jun 2, 2020
@Krytic Krytic mentioned this issue Jun 2, 2020
Merged
@Krytic
Copy link
Owner Author

Krytic commented Nov 10, 2020

Documentation is now written in RST and published on ReadTheDocs.

@Krytic Krytic added this to the v1.0.0 milestone Nov 10, 2020
Krytic added a commit that referenced this issue Nov 10, 2020
@Krytic
begin rewriting documentation (#4)
ed541b6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Krytic Krytic

Labels
documentation Improvements or additions to documentation priority:medium
Projects
Enhancements
  
To do
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@Krytic