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

Re-organization of the PSY docs to follow the Diataxis format #1148

Merged
merged 107 commits into from
Aug 2, 2024

Conversation

kdayday
Copy link
Contributor

@kdayday kdayday commented Jul 8, 2024

MVP of PSY docs using Diataxis

  • separates tutorials on how to's into different sections
  • new learn-by-doing tutorials: new basics tutorial and time-series tutorial
  • multiple partially redundant how-to's were either consolidated or most complete Version was retained and the rest deleted
  • some details in previous modeler guides moved into specific function docstrings, including over to infrastructure systems
  • added visibility of infrastructure systems functions and structs in PSY API (such as caches)
  • removed quick start guide and updated welcome page to include Sienna ecosystem intro and Diataxis Organization overview
  • Remove modeling with Jump example
  • Add migration guide announcement and documentation page
    - trivial type and parameter renames
    - new and removed types
    - Energy storage reservoir parameter updates (at least the ones that I/Kate did)
    - type hierarchy change
    - Horizon format
    - hybrid system (interconnection_efficiency is new, only works in 3.0),
    - Hydro status
    • cost functions

In future, to clean up how to's, including parsing how-to's, and clean up/expand explanation sections

resolves #1144
resolves #1145
resolve #935

kdayday and others added 30 commits May 31, 2024 15:52
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@kdayday kdayday mentioned this pull request Jul 29, 2024
1 task
@kdayday kdayday marked this pull request as ready for review July 29, 2024 21:51
Copy link
Member

@jd-lara jd-lara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am going to approve as it is and propose smaller changes as we find them

@jd-lara jd-lara merged commit 62a7ad4 into NREL-Sienna:main Aug 2, 2024
8 checks passed
@kdayday kdayday deleted the doc_org branch August 17, 2024 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants