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

Documentation Updates #36

Merged
merged 23 commits into from
Feb 12, 2025
Merged

Conversation

annacasavant
Copy link
Contributor

  • Updated to Documenter 1.0
  • Re-structured to follow Diataxias guidelines

@jd-lara
Copy link
Member

jd-lara commented Feb 6, 2025

@annacasavant you probably want to rebase this on main

@GabrielKS GabrielKS self-requested a review February 11, 2025 18:15
@GabrielKS
Copy link
Collaborator

I'll review again after documentation is passing and then this should be good to merge.

Copy link
Collaborator

@GabrielKS GabrielKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor changes then we're good to go

@@ -11,7 +11,7 @@ values are loaded results datasets.
- `scenarios::Union{Vector{AbstractString}, Nothing} = nothing`: a list of scenario
subdirectories to load, or `nothing` to load all the subdirectories
- `kwargs...`: keyword arguments to pass through to
[`PSI.get_decision_problem_results`](@ref)
`get_decision_problem_results`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the decision is to not try to make the PSI interlink work for now? That's fine, but if we hope to do it in the future can you add an issue for it? In general I expect the ability to nicely link to PSI reference will be useful more broadly than just this occurrence

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that was the decision. Agreed, we are going to need to figure out at some point why PSI isn't working with DocumenterInterLinks.

Copy link
Collaborator

@GabrielKS GabrielKS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works for now, I'll make a few minor tweaks in a subsequent documentation PR.

@jd-lara jd-lara merged commit 38b350a into NREL-Sienna:main Feb 12, 2025
5 checks passed
@GabrielKS
Copy link
Collaborator

@kdayday this is already merged, but would you mind briefly reviewing? I can make follow-up changes in #37 if necessary

@GabrielKS GabrielKS requested a review from kdayday February 16, 2025 02:33
@kdayday
Copy link
Contributor

kdayday commented Feb 17, 2025

@kdayday this is already merged, but would you mind briefly reviewing? I can make follow-up changes in #37 if necessary

@GabrielKS Overall, looks really good (@annacasavant)! I see a couple of changes that I want to make to SiennaTemplate that would trickle over here -- adding a About section similar to PSY and updating the developer guidelines. Only other comment is to ensure that #37 hides any stub pages that don't end up getting fleshed out/Replaced

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.

4 participants