Initial clean-up and reorganization of PowerSimulations documentation

[kennedy-mindermann]

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

• [x] Upgrading to Documenter > 1.0 and resolving errors to enforce strict compilation
• [x] Adding .md formatting to the formatter script
• [ ] Proof-reading for formatting and misformatted code references
• [ ] Adding hyperlinks everywhere
• [ ] Documentation badge at https://github.com/NREL-Sienna/PowerSimulations.jl?tab=readme-ov-file goes to latest (dev) instead of the stable version
• [ ] 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
• [ ] Check for missing documentation from the PowerFlows.jl in-the-loop integration. At least NetworkModel is missing power_flow_evaluation parameter (@GabrielKS for more info)

[jd-lara]

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

[kennedy-mindermann]

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

[jd-lara]

@kennedy-mindermann the code here in these repos.

https://github.com/NREL-Sienna/SIIP-Tutorial https://github.com/NREL-Sienna/OldExamples.jl