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

Improve documentation #25

Open
4 tasks
munshkr opened this issue Dec 26, 2021 · 0 comments
Open
4 tasks

Improve documentation #25

munshkr opened this issue Dec 26, 2021 · 0 comments
Labels
effort: 5 priority: now type: docs Related to documentation and information.

Comments

@munshkr
Copy link
Member

munshkr commented Dec 26, 2021 •
edited
Loading

This is a thread to discuss how to improve our documentation. Currently there is only a simple Sphinx autogenerated with some docstring coverage, but there are no Quickstart nor Tutorials.

I think there should be at least the following topics/sections:

  • Quickstart
  • Installation
  • Tutorials (notebook examples)
  • API Reference (needs to be updated, some functions have missing docstrings)

Usage should focus on both CLI and Python modes of operation

Originally posted by @munshkr in https://github.com/dymaxionlabs/satproc/discussions/14
munshkr added a commit that referenced this issue Feb 23, 2022
@munshkr
Install sphinx as dev package (#25)
48c9497
munshkr added a commit that referenced this issue Feb 23, 2022
@munshkr
Install sphinx as dev package (#25)
52bc086
@munshkr munshkr added type: docs Related to documentation and information. effort: 5 priority: now labels Feb 26, 2022
@munshkr munshkr moved this from Todo to In Progress in Dymaxion Labs public roadmap May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
effort: 5 priority: now type: docs Related to documentation and information.
Projects
No open projects
Dymaxion Labs public roadmap
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@munshkr