Skip to content

NGWPC-11670 - Add Streamlit Dashboard Documentation - #105

Merged
quercoak merged 3 commits into
mainfrom
NGWPC-11670
Aug 26, 2026
Merged

NGWPC-11670 - Add Streamlit Dashboard Documentation#105
quercoak merged 3 commits into
mainfrom
NGWPC-11670

Conversation

@brock-hinkson

Copy link
Copy Markdown

Add Streamlit Dashboard Documentation

Additions

  • Markdown files that constitute a comprehensive 'user guide' for the streamlit dashboard
  • Images that embed into the markdown files when rendered
  • Extra logic that allows mkdocs to serve the new docs

@brock-hinkson brock-hinkson self-assigned this Aug 24, 2026
@brock-hinkson brock-hinkson added the documentation Improvements or additions to documentation label Aug 24, 2026

@quercoak quercoak 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.

Generally looks good. See comments. Here's some other notes.

  • If you spin up the API docs you should see the formatting issues.
  • Please name the dashboard docs URI dashboard-docs . It's cleaner as dashboard but it might have collision issues with the fact that when deployed the uri is /dashboard for both the real dashboard and the dashboard docs. Part of this is that we should not have the docs just at the root of API, but that's just how it is.
  • Please add a blurb on the dashboard to the main index.md. I have some edits coming to that but that will have it be there when I'm ready to make them.

Comment thread docs/dashboard-docs/index.md
Comment thread docs/dashboard-docs/overview.md
Comment thread docs/dashboard/overview.md Outdated
Comment thread docs/dashboard/overview.md Outdated
Comment thread docs/dashboard/running.md Outdated
Comment thread docs/dashboard-docs/pages/ras_xs.md
Comment thread docs/dashboard-docs/pages/streamflow_observations.md
Comment thread docs/dashboard/pages/streamflow_observations.md Outdated
Comment thread docs/dashboard-docs/development.md
Comment thread docs/dashboard-docs/development.md
@brock-hinkson
brock-hinkson requested a review from quercoak August 25, 2026 20:13
@quercoak
quercoak merged commit afa4c3f into main Aug 26, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants