Skip to content

Add docs for built-in widgets - #63

Merged
PardhavMaradani merged 3 commits into
MDAnalysis:mainfrom
PardhavMaradani:built-in-widgets-docs
Aug 12, 2026
Merged

Add docs for built-in widgets#63
PardhavMaradani merged 3 commits into
MDAnalysis:mainfrom
PardhavMaradani:built-in-widgets-docs

Conversation

@PardhavMaradani

@PardhavMaradani PardhavMaradani commented Aug 11, 2026

Copy link
Copy Markdown
Member

Changes made in this Pull Request:

  • Added docs for current built-in widgets

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

Hi @orbeckst, @jeremyleung521, @amruthesht, @HeydenLabASU,

This PR adds docs for all existing built-in widgets. There is a lot more documentation to add, but this part about built-in widgets is now complete. While adding the docs, I realized that it might help to have a link to the docs directly where users actually use the widget in the dashboard - ie., in the widget details page. I made a note of this and will add this support later.

There is no change to any functionality.

Each widget has basic details and links pointing to MDAnalysis docs about what it does. There is an inputs section that specifies the possible inputs along with their defaults. An output section shows an example plot output. There are notes etc included based on the feedback received during individual widget PRs.

The rtd preview link: https://mdadash--63.org.readthedocs.build/en/63/

Thanks

@codecov

codecov Bot commented Aug 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (578534f) to head (08c6643).

Additional details and impacted files
Components Coverage Δ
frontend 100.00% <ø> (ø)
backend 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@PardhavMaradani
PardhavMaradani marked this pull request as ready for review August 11, 2026 12:39
@PardhavMaradani
PardhavMaradani merged commit 12cecfb into MDAnalysis:main Aug 12, 2026
20 checks passed
@PardhavMaradani
PardhavMaradani deleted the built-in-widgets-docs branch August 12, 2026 01:16
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.

1 participant