Ssh/docgen

[sriharisundar]

No description provided.

[codecov-commenter]

Codecov Report

❌ Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 84.06%. Comparing base (968a388) to head (71591c6).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
PRASCore.jl/src/Systems/SystemModel.jl	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #88      +/-   ##
==========================================
- Coverage   84.10%   84.06%   -0.05%     
==========================================
  Files          42       42              
  Lines        2001     2002       +1     
==========================================
  Hits         1683     1683              
- Misses        318      319       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull Request Overview

This PR implements comprehensive documentation generation for the PRAS (Probabilistic Resource Adequacy Suite) project. The documentation covers installation, user guides, API references, and examples for the complete PRAS ecosystem including its modular packages.

Key changes:

• Added complete documentation structure with installation, quick start, and detailed component guides
• Implemented API documentation for PRASCore, PRASFiles, and PRASCapacityCredits packages
• Added GitHub Actions workflows for automated documentation building and deployment

Reviewed Changes

Copilot reviewed 35 out of 40 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/src/*.md	Core documentation pages including installation, quick start, resource adequacy background, and extending PRAS
docs/src/PRAS/*.md	Detailed component documentation for system models, simulations, results, and capacity credits
docs/src/PRASCore/*.md	API documentation for the core PRAS functionality
docs/src/PRASFiles/*.md	API documentation for file handling capabilities
docs/src/PRASCapacityCredits/*.md	API documentation for capacity credit calculations
docs/make.jl	Documentation build configuration using Documenter.jl
.github/workflows/*.yml	GitHub Actions for automated documentation deployment and cleanup
PRASCore.jl/src/Systems/*.jl	Added comprehensive docstrings for system model components
PRAS.jl/examples/pras_walkthrough.jl	Complete tutorial example using RTS-GMLC system

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

There is a spelling error: 'unavailablity' should be 'unavailability'.

Suggested change

	as involuntary load shedding) due to resource unavailablity or deliverability
	as involuntary load shedding) due to resource unavailability or deliverability

[Copilot]

There is a spelling error: 'retreive' should be 'retrieve'.

Suggested change

	The recommended way to store and retreive PRAS system data is in an HDF5 file that conforms to the [PRAS system data format](./SystemModel_HDF5_spec.md). Once your system is represented in that format you can load it into PRAS with:
	The recommended way to store and retrieve PRAS system data is in an HDF5 file that conforms to the [PRAS system data format](./SystemModel_HDF5_spec.md). Once your system is represented in that format you can load it into PRAS with:

[Copilot]

There are spelling/grammar errors: 'calcuations' should be 'calculations' and 'to provided' should be 'to provide'.

Suggested change

	Capacity credit calcuations build on probabilistic resource adequacy assessment to provided capacity-based quantifications of the marginal benefit to system resource adequacy associated with a specific resource or collection of resources. Two capacity credit metrics (EFC and ELCC) are currently supported.
	Capacity credit calculations build on probabilistic resource adequacy assessment to provide capacity-based quantifications of the marginal benefit to system resource adequacy associated with a specific resource or collection of resources. Two capacity credit metrics (EFC and ELCC) are currently supported.