Skip to content

Cleanup and Docs#7

Merged
PardhavMaradani merged 1 commit into
MDAnalysis:mainfrom
PardhavMaradani:cleanup-and-docs
Jun 6, 2026
Merged

Cleanup and Docs#7
PardhavMaradani merged 1 commit into
MDAnalysis:mainfrom
PardhavMaradani:cleanup-and-docs

Conversation

@PardhavMaradani
Copy link
Copy Markdown
Collaborator

Changes made in this Pull Request:

  • Updated README.md to only include installation and run details
  • Moved developer details to DEVELOPMENT.md
  • Added missing test project dependencies to pyproject.toml
  • Cleanup unused stuff from cookiecutter template
  • Added 'Getting Started' details to readthedocs docs
  • Added more documentation to backend classes

PR Checklist

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

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

This PR cleans up the unused stuff from the cookiecutter template and adds more documentation. The README and the readthedocs documentation are updated to show clear instructions to install and run the dashboard server.

I will go ahead and merge this PR as the changes are mostly cleanup and docs.

Thanks

- Updated README.md to only include installation and run details
- Moved developer details to DEVELOPMENT.md
- Added missing test project dependencies to pyproject.toml
- Cleanup unused stuff from cookiecutter template
- Added 'Getting Started' details to readthedocs docs
- Added more documentation to backend classes
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (4860f90) to head (a4966ae).

🚀 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 merged commit 9596dcb into MDAnalysis:main Jun 6, 2026
20 checks passed
@PardhavMaradani PardhavMaradani deleted the cleanup-and-docs branch June 6, 2026 11:21
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