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

Split existing tutorials up into documentation on different levels #71

Open
apirogov opened this issue Oct 12, 2022 · 0 comments
Open

Split existing tutorials up into documentation on different levels #71

apirogov opened this issue Oct 12, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@apirogov
Copy link
Collaborator

apirogov commented Oct 12, 2022 •
edited
Loading

Currently, the Notebooks are in the uncanny valley between various kinds of documentation, while being not fully satisfactory on any single "level".

They should be broken apart and cross-linked.

There should be:

  • concepts (high abstraction level)
  • tutorial, bite-sized examples (concrete, copy-paste-able)
  • mid-level manual (explanation beyond what is in the docstrings)
  • automatic docs (the technical reference, generated from docstrings)
  • pure user docs (for users not writing code)
@apirogov apirogov added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 12, 2022
@github-actions github-actions bot added the triage Freshly opened or reopened issue label Oct 12, 2022
@apirogov apirogov changed the title Split existing tutorials up into concept level overview, complete manual and snippet-like tutorial recipes Split existing tutorials up into documentation on different levels Oct 12, 2022
@apirogov apirogov removed the triage Freshly opened or reopened issue label Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@apirogov