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 structure #93

Open
14 tasks
TomNicholas opened this issue Sep 18, 2024 · 0 comments
Open
14 tasks

Documentation structure #93

TomNicholas opened this issue Sep 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@TomNicholas
Copy link
Contributor

TomNicholas commented Sep 18, 2024 •
edited
Loading

We should try to follow this overall structure for documentation.

image

(see https://docs.divio.com/documentation-system/)

Status

  • Tutorials
    • I think the existing notebooks count as tutorials?
  • Explanation Long-form explanation of high-level concepts
    • What C-Star aims to do for you
    • Case vs blueprint
    • Some mention of future plans of providing pre-approved blueprints
  • How-to Guides
    • How to run an off-the-shelf configuration
    • How to set up your own domain from scratch
    • How to not get bottlenecked by regridding
  • Reference
    • API docs can be seen here, but might need filling out a little bit (e.g. following standard formatting, adding examples and cross-links where appropriate)
    • Glossary Glossary of terms #28
  • README (Rewrite to follow these recommendations)
@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Sep 18, 2024
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TomNicholas