Doc fix: updated the PEcAn book's model pages (05_models) #3780
Conversation
ayushman1210
changed the title
|
Hey @infotroph please review this pr [#3780 ]when you have free time no rush just a gentle reminder |
There was a problem hiding this comment.
@ayushman1210 thank you for taking a pass at this. It is a nice step forward.
Before merging, I'd like to request one change and then get feedback from other maintainers on the table contents:
Change requested:
- The 05_models/.Rmd files seem redundant with the model-specific READMEs that will be posted on the pkgdown documentation files. Is there any reason not to remove these files, update links to the pkgdown page, and move 05_models/00_model_index.Rmd to 05_models.Rmd?
- Check the package READMEs - it seems that the 'model information' table should link to the source code / docs / authors of the model, not the PEcAn model wrapper.
Questions for other maintainers:
- In the summary table is clear, some columns are not clear.
- should Available in VM be replaced with "Available in Docker"?
- It isn't clear how "Prescribed Inputs" and "Input Functions/Values" differ. Would it make sense to have columns representing (or explicitly named after) specific coupler functions (e.g. met2model, write.configs, model2netcdf, read/write restart)?
The model index was moved to the parent directory as 05_models.Rmd to avoid redundancy with model-specific documentation now hosted on pkgdown. The old 00_model_index.Rmd was causing a duplicate 'pecan-models' anchor ID in bookdown, preventing successful documentation builds. This commit removes the duplicate file while keeping the consolidated documentation.
This is a workaround for CI issues where autogenerated files need to be regenerated to match the expected format after merging develop branch changes to DESCRIPTION files.
|
Hi @dlebauer , |
|
Hi @dlebauer |
2 participants
I've updated the PEcAn book's model pages (05_models) with comprehensive links and metadata. Here's what was accomplished:
New Model Pages Created (7)
Each includes:
Metadata table (Home Page, Source Code, Package Docs, License, Authors)
Installation instructions
Links to Package README, R documentation, and external resources
[README.md] : Replaced generic template with package-specific content (installation, features, references)
[README.md] : Replaced generic template with work-in-progress status and guidance
Fixes
#3746