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 PowerSimulations documentation #1165

Open
2 of 10 tasks
kennedy-mindermann opened this issue Oct 17, 2024 · 3 comments
Open
2 of 10 tasks

Comments

@kennedy-mindermann
Copy link

kennedy-mindermann commented Oct 17, 2024

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

  • Upgrading to Documenter > 1.0 and resolving errors to enforce strict compilation
  • Adding .md formatting to the formatter script
  • Proof-reading for formatting and misformatted code references
  • Adding hyperlinks everywhere
  • Move tutorials to documentation
  • Simulation recorder needs Type docstrings & working code examples
    • Recorder event types, such as SimulationStepEvent, in recorder_events.jl need docstrings
    • Specific recorder event types are referenced in the Simulation Recorder page, and need hyperlinks to new docstrings
    • Simulation Recorder examples should be updated with working @example or @repl blocks instead of copy-pasted julia blocks
    • Current julia blocks are causing formatter to fail. There is an ignore for "simulation_recorder.md" that should be removed one it's updated
@jd-lara
Copy link
Member

jd-lara commented Oct 17, 2024

@kennedy-mindermann we should close all the other issues opened about documentation to consolidate that in a single effort

@kennedy-mindermann
Copy link
Author

@jd-lara what tutorials need to be moved to the documentation? Would be good to include that information here

@jd-lara
Copy link
Member

jd-lara commented Nov 6, 2024

@kennedy-mindermann kennedy-mindermann changed the title Initial clean-up of PowerSimulations documentation Initial clean-up and reorganization of PowerSimulations documentation Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants