Skip to content

Conversation

@Sylviabohnenstengel
Copy link
Contributor

@Sylviabohnenstengel Sylviabohnenstengel commented Nov 25, 2025

fixes #1823

Contribution checklist

Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.

  • Documentation has been updated to reflect change.
  • New code has tests, and affected old tests have been updated.
  • All tests and CI checks pass.
  • Ensured the pull request title is descriptive.
  • Conda lock files have been updated if dependencies have changed.
  • Attributed any Generative AI, such as GitHub Copilot, used in this PR.
  • Marked the PR as ready to review.

…tions and reflecting seamless approach for time and space scales i.e. weather and (regional) climate in documentation
@Sylviabohnenstengel Sylviabohnenstengel self-assigned this Nov 25, 2025
@Sylviabohnenstengel Sylviabohnenstengel added this to the CSET v25.11.0 milestone Nov 25, 2025
@Sylviabohnenstengel Sylviabohnenstengel added the documentation Improvements or additions to documentation label Nov 25, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 25, 2025

Coverage

@Sylviabohnenstengel Sylviabohnenstengel marked this pull request as ready for review November 25, 2025 17:55
Copy link
Contributor

@ukmo-huw-lewis ukmo-huw-lewis left a comment

Choose a reason for hiding this comment

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

In general, think these are looking like good changes.

Review has got me thinking further on some aspects, maybe in particular greater use of bullets to aid readability, and some suggested/requested changes to phrasing and emphasis that I hope worth considering before we make these changes.

Note also comment on value of consistency with top-level GitHub pages.

Finally, given the shift to Community Seamless Evaluation Toolkit, I have had in view the value of setting out what these words mean - I think each is powerful and usefully explain some of the 'philosophy' and what to expect from CSET. Can we add this narrative somewhere? A starter for 10 offered below (have a go at making these shorter/impactful etc):

Community: Software developed for and by a wide network of model development and evaluation scientists, enabling common approaches to distributed evaluation activities.
Seamless: Supporting assessment, evaluation, verification and understanding of physical and machine learning models across time and space scales, and from regional to global application.
Evaluation: Providing a process-oriented focus to model assessment, supporting depth of comparison between different model configurations and assessment relative to a range of observations.
Toolkit: A flexible software including code, recipes and workflow to manage a range of user requirements, underpinned by modern software development practices.

Copy link
Contributor Author

@Sylviabohnenstengel Sylviabohnenstengel left a comment

Choose a reason for hiding this comment

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

worked though your suggestions and included them into the documents. Still working on some changes

@Sylviabohnenstengel
Copy link
Contributor Author

Still working on some changes so please don't merge.

@Sylviabohnenstengel
Copy link
Contributor Author

GitHub copilot used to help with formatting

@Sylviabohnenstengel
Copy link
Contributor Author

@Fraetor wondering if the Why CSET? section under background is becoming obsolete.

@jfrost-mo
Copy link
Member

The "Why CSET" page is intended to provide detailed justification for CSET without overwhelming people on the documentation landing page. So I'm not sure its becoming obsolete, but it may need updating to reflect CSET's current position.

@jfrost-mo jfrost-mo marked this pull request as draft November 27, 2025 09:53
@jfrost-mo jfrost-mo changed the title updating documentation: larger remit of CSET to ML models and observa… Update documentation to reflect larger remit of CSET Nov 27, 2025
Copy link
Contributor Author

@Sylviabohnenstengel Sylviabohnenstengel left a comment

Choose a reason for hiding this comment

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

happy with changes

@Sylviabohnenstengel Sylviabohnenstengel marked this pull request as ready for review November 27, 2025 11:56
Copy link
Member

@jfrost-mo jfrost-mo left a comment

Choose a reason for hiding this comment

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

I think the documentation landing page (index.rst) is probably getting a little bit overwhelmed with detail. My suggestion would be to cut it down, so it has the same content as the README, and move the additional detail to the why-cset page. Then have a link from the index to the why-cset page.

This way, people who are already convinced are not overwhelmed with excessive detail or background, while those that desire it can find out more about the rational.

The additional details have been moved to the why-cset page, so they are
not as overwhelming for someone's first visit to the documentation.
@jfrost-mo
Copy link
Member

I've made some changes in #1831. If you are happy with them you should be able to merge that PR into this one.

Reword and unify README and documentation home page
Copy link
Member

@jfrost-mo jfrost-mo left a comment

Choose a reason for hiding this comment

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

As Sylvia is unavailable I've merge in my suggested changes so we can get the December release out.

@jfrost-mo jfrost-mo dismissed ukmo-huw-lewis’s stale review December 4, 2025 09:44

Changes have been addressed.

@jfrost-mo jfrost-mo merged commit 5767cbd into main Dec 4, 2025
8 checks passed
@jfrost-mo jfrost-mo deleted the 1823_update_documentation_to_reflect_new_CSET_name branch December 4, 2025 09:44
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.

Update documentation to reflect larger CSET remit

4 participants