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

Initial clean-up and reorganization of StorageSystemsSimulations documentation #45

Open
2 of 12 tasks
kennedy-mindermann opened this issue Oct 17, 2024 · 2 comments
Open
2 of 12 tasks
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kennedy-mindermann
Copy link

kennedy-mindermann commented Oct 17, 2024

The existing StorageSystemsSimulations documentation needs to be cleaned up prior to reorganizing with the new Diataxis format. This includes:

  • Upgrading to Documenter > 1.0
  • resolving errors to enforce strict compilation by removing warnonly=[:missing_docs], after Kate adds "How to resolve missing docstrings" to docs best practices
  • Adding .md formatting to the formatter script
  • Proof-reading for formatting and misformatted code references
  • Adding hyperlinks everywhere
  • Reorganize top level headings for Diataxis
  • Review existing quick start guide and welcome page, and organize by Diataxis (See PowerSystems for example)
  • Map current tutorials to either Tutorials or How-tos
  • Replicate Reference format from PowerSystems.jl
  • Add Formulation Library under Reference
  • All docs references must be in the API. All docs references in Formulation Library should be referenced as non-canonical: https://documenter.juliadocs.org/stable/man/syntax/#noncanonical-block
  • To figure out: Should Attributes list be an arguments list? Compare to what's going on in PowerSimulations
@kdayday
Copy link
Contributor

kdayday commented Nov 1, 2024

#31 enforces strict compilation

@kennedy-mindermann kennedy-mindermann added the documentation Improvements or additions to documentation label Nov 6, 2024
@kennedy-mindermann kennedy-mindermann changed the title Initial clean-up of StorageSystemsSimulations documentation Initial clean-up and reorganization of StorageSystemsSimulations documentation Nov 19, 2024
@annacasavant
Copy link

annacasavant commented Nov 26, 2024

The existing StorageSystemsSimulations documentation needs to be cleaned up prior to reorganizing with the new Diataxis format. This includes:

  • Upgrading to Documenter > 1.0
  • resolving errors to enforce strict compilation by removing warnonly=[:missing_docs], after Kate adds "How to resolve missing docstrings" to docs best practices
  • Adding .md formatting to the formatter script
  • Proof-reading for formatting and misformatted code references
  • Adding hyperlinks everywhere
  • Reorganize top level headings for Diataxis
  • Review existing quick start guide and welcome page, and organize by Diataxis (See PowerSystems for example)
  • Map current tutorials to either Tutorials or How-tos
  • Replicate Reference format from PowerSystems.jl
  • Add Formulation Library under Reference
  • All docs references must be in the API. All docs references in Formulation Library should be referenced as non-canonical: https://documenter.juliadocs.org/stable/man/syntax/#noncanonical-block
  • To figure out: Should Attributes list be an arguments list? Compare to what's going on in PowerSimulations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants