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

Make the docs stroy line more clear to simplify navigation #1132

Open
fwitte opened this issue Nov 8, 2024 · 0 comments · May be fixed by #1131
Open

Make the docs stroy line more clear to simplify navigation #1132

fwitte opened this issue Nov 8, 2024 · 0 comments · May be fixed by #1131

Comments

@fwitte
Copy link
Member

fwitte commented Nov 8, 2024

Idea

  • Landing page
  • User guide
    • Installation
    • Tutorials on the modeling of very basic systems (explanatory with storytelling)
    • Tutorials on more advanced systems (explanatory with storytelling)
    • More examples on advanced methods
    • Example applications of oemof-solph, that are very suffisticated (links to external libraries)
  • Documentation
    • Meta documentation on the different parts of oemof (walk through kind of style as in the current user's guide)
      • general overview
      • components
      • investment optimization
      • ...
    • API docs
    • Changelog
    • Literature (?)
  • Contribute
    • What to contribute
    • How to contribute
    • oemof association information

The high level points should have neat overviews to illustrate the contents of the different subchapters. Blueprint version of this is the tespy toc

@fwitte fwitte linked a pull request Nov 22, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant