Skip to content

Update documentation documentation#3908

Open
samsrabin wants to merge 17 commits intoESCOMP:b4b-devfrom
samsrabin:docs-docs-202604
Open

Update documentation documentation#3908
samsrabin wants to merge 17 commits intoESCOMP:b4b-devfrom
samsrabin:docs-docs-202604

Conversation

@samsrabin
Copy link
Copy Markdown
Member

@samsrabin samsrabin commented Apr 2, 2026

Description of changes

When this PR is complete, it will:

  • Add instructions for building and previewing on Casper
  • Add "Contributing to the documentation" instructions
  • Add style guide

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed:

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? n/a

Testing performed, if any: Local builds and GitHub Workflows.

@samsrabin samsrabin self-assigned this Apr 2, 2026
@samsrabin samsrabin added documentation additions or edits to user-facing documentation or its infrastructure bfb bit-for-bit test: docs Test documentation build before merging docs:new New documentation needed (e.g., for a new feature) docs:update Significant update or fix needed to existing documentation docs-loc:users-guide Relates to User's Guide (using CTSM/tools) labels Apr 2, 2026
@samsrabin samsrabin marked this pull request as ready for review April 4, 2026 00:43
@samsrabin samsrabin added the PR status: awaiting review Work on this PR is paused while waiting for review. label Apr 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bfb bit-for-bit docs:new New documentation needed (e.g., for a new feature) docs:update Significant update or fix needed to existing documentation docs-loc:users-guide Relates to User's Guide (using CTSM/tools) documentation additions or edits to user-facing documentation or its infrastructure PR status: awaiting review Work on this PR is paused while waiting for review. test: docs Test documentation build before merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

User's Guide: Add "Contributing to documentation" documentation

1 participant