Closed michaelweinold closed 1 year ago
Not sure if useful, but I really like the template that pvlib implemented and this pull request shows the changes in my repo which looked similar to brightways to obtain that sidebar and topbar division of content, as well as the Gallery of journal examples.
Not sure if useful, but I really like the template that pvlib implemented and this pull request shows the changes in my repo which looked similar to brightways to obtain that sidebar and topbar division of content, as well as the Gallery of journal examples.
This readthedocs page looks great - we'll make sure to adapt our prototoype to reflect the layout.
Also as an afterthought -- I don't see this in an obvious manner in the current documentation, so it'd be great to include a What's new with every sub package release that feeds into the main whats new.
Also as an afterthought -- I don't see this in an obvious manner in the current documentation, so it'd be great to include a What's new with every sub package release that feeds into the main whats new.
Agreed! There will be more structured changelog template also. Compare also the https://gitter.im/brightway-lca/announcements Gitter room for announcements of this nature.
Brainstorming session "what would the worst documentation look like"?
All further tasks are tracked in the documentation
and the training
repos:
https://github.com/brightway-lca/brightway-documentation/issues
https://github.com/brightway-lca/brightway-training/issues
Brainstorming session result:
Documentation Hackathon the worst possible documentation.pdf
⚠️ This issue is only for organizing tasks related to the hackathon setup. For actual issues related to documentation, compare the two relevant repositories:
https://github.com/brightway-lca/brightway-documentation-jupyter-book https://github.com/brightway-lca/brightway-documentation-readthedocs
ℹ️ Hackathon Information
As the functionality and the user base of Brightway continues to grow, the documentation must grow too. The current vision is to split up the documentation into:
🗓 Hackathon Schedule
☑️ Hackathon Agenda
Technical Documentation
BEFORE the Hackathon
DURING the Hackathon
https://2.docs.brightway.dev/technical/*
tobrightway.readthedocs.org
User Documentation
BEFORE the Hackathon
DURING the Hackathon
binder.org
orcolabs
orhub.brightway.dev
)🌐 Useful Links
Brightway Strategic Development Plan Brightway Jupyter Books Documentation Diataxis Documentation Framework documentation-as-a-way-to-build-community Gallery of Jupyter Books