Skip to content

Fill out documentation#36

Closed
kdayday wants to merge 6 commits into
mainfrom
kd/docs
Closed

Fill out documentation#36
kdayday wants to merge 6 commits into
mainfrom
kd/docs

Conversation

@kdayday

@kdayday kdayday commented Feb 19, 2026

Copy link
Copy Markdown
Collaborator

This is a combo documentation infrastructure update + docstrings update.

  • Breaking change typo fix: ComplentarySlacknessCyclingChargeComplementarySlacknessCyclingCharge
    ComplentarySlacknessCyclingDischargeComplementarySlacknessCyclingDischarge

  • update to documenter >1.0

  • update formatter and run

  • Add tutorials processing infrastructure (though there are none)

  • Add docstrings for exported and referenced types

    • Formulations are documented within type docstrings, rather than separate formulation library
  • update landing page and general organization to for Diataxis format

  • Two TODO DOCS are left in MerchantHybridBilevelCase and OptConditionEnergyVariable because AI didn't have enough to go on.

View: https://nrel-sienna.github.io/HybridSystemsSimulations.jl/previews/PR36/

@kdayday kdayday marked this pull request as ready for review February 23, 2026 21:32
@kdayday kdayday changed the title [WIP] Fill out documentation Fill out documentation Feb 23, 2026
@kdayday kdayday closed this Apr 16, 2026
@kdayday

kdayday commented Apr 16, 2026

Copy link
Copy Markdown
Collaborator Author

Closing as duplicate #37

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 this pull request may close these issues.

1 participant