landing page updates#6
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
WalkthroughDocumentation for landfirevegmodels updated to reflect SyncroSim 3.1.25+ requirement and current package versions. Getting started guide revised to use online template workflow with CONUS/HI and Alaska template options, and configuration instructions now target specific LANDFIRE vegetation models datafeeds. Homepage refreshed with updated dependency statement and team contact link. ChangesDocumentation updates for SyncroSim 3.1.25 and package versions
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting_started.md`:
- Around line 21-27: Add meaningful alt text attributes to the <img> tags shown
(assets/images/image-1.png, image-2.png, image-3.png) to satisfy accessibility
and markdownlint MD045; update each tag in docs/getting_started.md to include
descriptive alt strings (e.g., alt="Screenshot: <brief description>") and do the
same for the other images referenced around lines 44-50 so all instructional
screenshots have appropriate alt text.
- Around line 17-25: The docs require SyncroSim >= 3.1.29 but the package
manifest still advertises minSyncroSimVersion="3.1.25"; update the manifest to
match the docs by changing the minSyncroSimVersion attribute in src/package.xml
to "3.1.29" (or alternatively update the docs to "3.1.25" if you intend to keep
the older minimum) and ensure the value in the package.xml's manifest tag
(minSyncroSimVersion) and the README/docs text are identical so users receive
consistent install requirements.
In `@docs/index.md`:
- Around line 15-17: In the opening paragraph under the "###
**landfirevegmodels**" header, correct the typos by changing "moidels" to
"models" and changing "contains" to "contain" so the sentence reads correctly
for the plural subject; update that sentence in docs/index.md where the package
description appears.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 62c08357-ccaf-47cc-8ffb-3b7a049bacaa
⛔ Files ignored due to path filters (9)
docs/assets/images/image-1.pngis excluded by!**/*.pngdocs/assets/images/image-2.pngis excluded by!**/*.pngdocs/assets/images/image-3.pngis excluded by!**/*.pngdocs/assets/images/image-4.pngis excluded by!**/*.pngdocs/assets/images/image-5.pngis excluded by!**/*.pngdocs/assets/images/image-6.pngis excluded by!**/*.pngdocs/assets/images/project-landfire-tab-opened.pngis excluded by!**/*.pngdocs/assets/images/scenario-landfire-tab-opened.pngis excluded by!**/*.pngdocs/assets/images/scenario-landfire-tab.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/getting_started.mddocs/index.md
| <img align="middle" style="padding: 1px" width="500" src="assets/images/image-1.png"> | ||
|
|
||
| <img align="middle" style="padding: 1px" width="500" src="assets/images/image-2.png"> | ||
|
|
||
| Repeat the same process for **landfirevegmodels** (version 2.0.0). | ||
|
|
||
| <img align="middle" style="padding: 1px" width="500" src="assets/images/image-3.png"> |
There was a problem hiding this comment.
Add alt text to the screenshots. These instructional images are missing alt text, which hurts screen readers and keeps the markdownlint MD045 warnings alive.
Also applies to: 44-50
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 21-21: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 23-23: Images should have alternate text (alt text)
(MD045, no-alt-text)
[warning] 27-27: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting_started.md` around lines 21 - 27, Add meaningful alt text
attributes to the <img> tags shown (assets/images/image-1.png, image-2.png,
image-3.png) to satisfy accessibility and markdownlint MD045; update each tag in
docs/getting_started.md to include descriptive alt strings (e.g.,
alt="Screenshot: <brief description>") and do the same for the other images
referenced around lines 44-50 so all instructional screenshots have appropriate
alt text.
Source: Linters/SAST tools
| ### **landfirevegmodels** is a SyncroSim package that delivers pre-built [LANDFIRE](https://landfire.gov/){:target="_blank"} state-and-transition models of vegetation dynamics for ecosystems across the United States. | ||
|
|
||
| The **landfirevegmodels** package contains hundreds of state-and-transition simulation models (STSMs) of Biophysical Settings (BpS), designed by The Nature Conservancy's LANDFIRE program in collaboration with experts across the United States. These BpS models are reference condition models depicting what ecosystems may have looked like prior to European colonization of North America. The purpose of the **landfirevegmodels** package is to provide baseline models that can be modified to represent current landscapes and used to forecast the effects of ecosystem disturbances and/or management actions through simulations. | ||
| The moidels included in the **landfirevegmodels** package contains hundreds of state-and-transition simulation models (STSMs) of Biophysical Settings (BpS), designed by The Nature Conservancy's LANDFIRE program in collaboration with experts across the United States. These BpS models are reference condition models depicting what ecosystems may have looked like prior to European colonization of North America. The purpose of the **landfirevegmodels** package is to provide baseline models that can be modified to represent current landscapes and used to forecast the effects of ecosystem disturbances and/or management actions through simulations. Built on top of ST-Sim, the package comes with the models already constructed so you can focus on modifying and applying them to your area of interest rather than building from scratch. |
There was a problem hiding this comment.
Fix the typo in the opening paragraph. moidels should be models, and contains should be contain because the subject is plural. This is user-facing copy, so it should read cleanly.
🧰 Tools
🪛 LanguageTool
[style] ~17-~17: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ng what ecosystems may have looked like prior to European colonization of North America....
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/index.md` around lines 15 - 17, In the opening paragraph under the "###
**landfirevegmodels**" header, correct the typos by changing "moidels" to
"models" and changing "contains" to "contain" so the sentence reads correctly
for the plural subject; update that sentence in docs/index.md where the package
description appears.
changed to 3.1.25 to align with the package xml
fix typo align syncrosim version with the package xml
Updated landing page screenshots and text based on Diego's review
Summary by CodeRabbit