Skip to content

landing page updates#6

Open
kerr-hub wants to merge 3 commits into
ApexRMS:masterfrom
kerr-hub:master
Open

landing page updates#6
kerr-hub wants to merge 3 commits into
ApexRMS:masterfrom
kerr-hub:master

Conversation

@kerr-hub

@kerr-hub kerr-hub commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Updated landing page screenshots and text based on Diego's review

Summary by CodeRabbit

  • Documentation
    • Updated Getting Started guide with current version requirements (SyncroSim 3.1.25+, stsim 4.5.3+, landfirevegmodels 2.0.0+) and refreshed installation steps
    • Clarified library creation workflow using “From Online Template...” with CONUS/HI vs Alaska template choices
    • Updated library configuration instructions for the “LANDFIRE vegetation models” tab(s) and refreshed screenshots
    • Revised homepage content to reflect the updated SyncroSim requirement and refreshed LANDFIRE team link wording/details

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b4309470-425a-4cc1-acf3-14edfc6ffeab

📥 Commits

Reviewing files that changed from the base of the PR and between a0f9197 and 3591c4e.

📒 Files selected for processing (2)
  • docs/getting_started.md
  • docs/index.md
✅ Files skipped from review due to trivial changes (1)
  • docs/getting_started.md

Walkthrough

Documentation 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.

Changes

Documentation updates for SyncroSim 3.1.25 and package versions

Layer / File(s) Summary
Getting started workflow guide
docs/getting_started.md
Installation steps updated to SyncroSim 3.1.25+, stsim 4.5.3+, and landfirevegmodels 2.0.0. Library creation workflow changed to use "From Online Template..." with two template choices (CONUS/HI vs Alaska reference conditions). Configuration instructions revised to target "LANDFIRE vegetation models" tabs from specific datafeeds. ST-Sim integration terminology refined in Learn more section.
Homepage documentation and team contact
docs/index.md
Homepage introductory description rewritten and SyncroSim version requirement updated from 2.2.19 to 3.1.25 or newer. LANDFIRE team contact link in Developers section updated to new ArcGIS StoryMaps URL.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'landing page updates' is vague and overly broad; it uses non-descriptive terminology that doesn't convey what specific changes were made to the landing pages. Consider a more specific title such as 'Update SyncroSim version requirement to 3.1.25 in documentation' or 'Update getting-started and index documentation with revised instructions and links'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3e58e71 and a0f9197.

⛔ Files ignored due to path filters (9)
  • docs/assets/images/image-1.png is excluded by !**/*.png
  • docs/assets/images/image-2.png is excluded by !**/*.png
  • docs/assets/images/image-3.png is excluded by !**/*.png
  • docs/assets/images/image-4.png is excluded by !**/*.png
  • docs/assets/images/image-5.png is excluded by !**/*.png
  • docs/assets/images/image-6.png is excluded by !**/*.png
  • docs/assets/images/project-landfire-tab-opened.png is excluded by !**/*.png
  • docs/assets/images/scenario-landfire-tab-opened.png is excluded by !**/*.png
  • docs/assets/images/scenario-landfire-tab.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • docs/getting_started.md
  • docs/index.md

Comment thread docs/getting_started.md Outdated
Comment thread docs/getting_started.md
Comment on lines +21 to +27
<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">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Comment thread docs/index.md Outdated
Comment on lines +15 to +17
### **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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

@diegobilski diegobilski self-requested a review June 12, 2026 20:02
changed to 3.1.25 to align with the package xml
fix typo 
align syncrosim version with the package xml

@diegobilski diegobilski left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

looks good

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.

2 participants