Skip to content

Update documentation layout#433

Merged
sjsprecious merged 14 commits intomainfrom
update_documentation_layout
Jul 17, 2025
Merged

Update documentation layout#433
sjsprecious merged 14 commits intomainfrom
update_documentation_layout

Conversation

@angelapak
Copy link
Copy Markdown
Contributor

@angelapak angelapak commented Jul 17, 2025

Initial reorganization of MUSICA documentation. Main changes:

  • moves overview statement to home page
  • separates each page between Fortran and Python examples
  • adds READMe python example to getting started page
  • adds existing Fortran tutorials to getting started page
  • establish user guide sections (to be filled in a separate PR)
  • establish tutorial sections (to be filled in a separate PR)
  • establish contributing guide sections (to be filled in a separate PR)
  • establish citing MUSICA page ((to be filled in a separate PR))

closes #411

@angelapak angelapak requested a review from sjsprecious July 17, 2025 03:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jul 17, 2025

📄 Documentation for this branch is available at: https://ncar.github.io/musica/branch/update_documentation_layout/

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jul 17, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.63%. Comparing base (9b329cc) to head (00eadb5).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #433   +/-   ##
=======================================
  Coverage   83.63%   83.63%           
=======================================
  Files          48       48           
  Lines        4093     4093           
=======================================
  Hits         3423     3423           
  Misses        670      670

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sjsprecious
sjsprecious approved these changes Jul 17, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@sjsprecious sjsprecious left a comment

Choose a reason for hiding this comment

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

Thanks @angelapak for working on this. It looks good to me.

@sjsprecious sjsprecious merged commit d6ecf0d into main Jul 17, 2025
69 checks passed
@sjsprecious sjsprecious deleted the update_documentation_layout branch July 17, 2025 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sjsprecious sjsprecious sjsprecious approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

create new documentation layout

3 participants

@angelapak @codecov-commenter @sjsprecious