Skip to content

Conversation

@xylar
Copy link
Contributor

@xylar xylar commented Jul 20, 2025

This pull request enhances the E3SM-Unified documentation by adding new sections, reorganizing content, and providing detailed information about tools and packages included in the environment. The changes improve clarity, accessibility, and usability for users and contributors.

Documentation Enhancements

  • Added Table of Contents: Introduced a hidden, structured table of contents in docs/index.md to improve navigation across documentation pages.

  • Reorganized Content: Removed redundant links and streamlined the "Contents" section in docs/index.md for better readability.

New Tool Documentation

  • Detailed Tool Summaries: Added a comprehensive guide in docs/using-tools.md for tools like E3SM Diags, MOAB, MPAS-Analysis, NCO, zppy, and zstash, including usage examples, quickstart guides, and links to further documentation.

Package Information

  • Package Catalog: Created a new section in docs/packages.md listing all packages included in the E3SM-Unified environment (1.11.1), along with version constraints and dependencies. This serves as a reference for users and developers.

@xylar xylar self-assigned this Jul 20, 2025
@xylar xylar merged commit 17f147a into E3SM-Project:main Jul 20, 2025
8 checks passed
@xylar xylar deleted the fix-docs branch July 20, 2025 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant