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

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

annacasavant
Copy link

  • 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
docs/make.jl Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/src/reference/developer_guidelines.md Outdated Show resolved Hide resolved
docs/src/reference/public.md Show resolved Hide resolved
scripts/formatter/formatter_code.jl Show resolved Hide resolved
docs/make.jl Show resolved Hide resolved
@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

docs/make.jl Outdated Show resolved Hide resolved
@@ -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

docs/src/how_to_guides/stub.md Outdated Show resolved Hide resolved
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.

3 participants