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

Pre-release quality assurance documentation tasks #164

Closed
3 of 6 tasks
alvorithm opened this issue May 7, 2020 · 0 comments
Closed
3 of 6 tasks

Pre-release quality assurance documentation tasks #164

alvorithm opened this issue May 7, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@alvorithm
Copy link
Contributor

alvorithm commented May 7, 2020

  • Check docs for coverage, readability, correctness.
    • Add a mixture of Gaussians example.
  • Share nomenclature mapping. @Meteore
  • Go through README.md, add links, polish.
  • Move guide regarding user inputs from markdown file in subfolder into docs and polish @janfb @Meteore
  • Work out which links are entry points for public announcements (e.g. Twitter): tutorial, github, etc., and double-check their content.
@alvorithm alvorithm self-assigned this May 7, 2020
@alvorithm alvorithm added this to the First public release milestone May 7, 2020
@alvorithm alvorithm added the help wanted Extra attention is needed label May 7, 2020
@alvorithm alvorithm changed the title Pre-release quality assurance checks Pre-release quality assurance documentation tasks Jun 9, 2020
@alvorithm alvorithm added the documentation Improvements or additions to documentation label Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants