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

Rework the manual #2595

Closed
bkamins opened this issue Jan 8, 2021 · 1 comment
Closed

Rework the manual #2595

bkamins opened this issue Jan 8, 2021 · 1 comment
Labels
Milestone

Comments

@bkamins
Copy link
Member

bkamins commented Jan 8, 2021

The manual probably should be rewritten so that:

  1. it clearly separates the "reference" part, the "design concepts" part and the "tutorial" part
  2. it covers all the essential functions that we provide
  3. it consistently uses a well thought of data set (or several data sets, but not many) so that the reader can follow this

I guess it would be preferable to do it before 1.0 release

@bkamins bkamins added the doc label Jan 8, 2021
@bkamins bkamins added this to the 1.0 milestone Jan 8, 2021
@bkamins bkamins mentioned this issue Jan 8, 2021
@bkamins bkamins mentioned this issue Mar 4, 2021
19 tasks
@bkamins bkamins modified the milestones: 1.0, 1.x Mar 25, 2021
@bkamins
Copy link
Member Author

bkamins commented Nov 22, 2021

closing as it should be fixed incrementally.

@bkamins bkamins closed this as completed Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant