Skip to content

Convert READMEs to markdown#3816

Open
slevis-lmwg wants to merge 7 commits intoESCOMP:b4b-devfrom
slevis-lmwg:readmes_to_md
Open

Convert READMEs to markdown#3816
slevis-lmwg wants to merge 7 commits intoESCOMP:b4b-devfrom
slevis-lmwg:readmes_to_md

Conversation

@slevis-lmwg
Copy link
Contributor

Description of changes

See title

Specific notes

Contributors other than yourself, if any:

CTSM Issues Fixed (include github issue #):
Fixes #2761

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?
No

Testing performed, if any:
None needed

@slevis-lmwg slevis-lmwg self-assigned this Mar 16, 2026
@slevis-lmwg slevis-lmwg added documentation additions or edits to user-facing documentation or its infrastructure bfb bit-for-bit docs:update Significant update or fix needed to existing documentation docs-loc:other Relates to documentation somewhere not covered by the other docs-loc labels. labels Mar 16, 2026
@slevis-lmwg slevis-lmwg moved this to In Progress in CLM documentation Mar 16, 2026
@github-project-automation github-project-automation bot moved this to Ready to start (or start again) in CTSM: Upcoming tags Mar 16, 2026
@slevis-lmwg slevis-lmwg moved this from Ready to start (or start again) to In progress - b4b-dev in CTSM: Upcoming tags Mar 16, 2026
See if this renders better.
@slevis-lmwg
Copy link
Contributor Author

Note to self: Look for more READMEs that need conversion.

@ekluzek how should we handle the presence of both a README and a README.md in the /ctsm directory?

@ekluzek
Copy link
Collaborator

ekluzek commented Mar 16, 2026

@ekluzek how should we handle the presence of both a README and a README.md in the /ctsm directory?

@slevis-lmwg

Good question. The README.md shows up as what you see on github. And it's probably something we want to be short, with the main content being what we want people to see when they got to CTSM on github. In contrast, the content of the README details about how to use CTSM and some practical details about how to get around in the checkout.

So you could add the content of the plain README to the README.md, but make it at the end. The other option would be to have a file with a different name maybe something like: README_on_CTSM.md? Which sounds better to you?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bfb bit-for-bit docs:update Significant update or fix needed to existing documentation docs-loc:other Relates to documentation somewhere not covered by the other docs-loc labels. documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: In Progress
Status: In progress - b4b-dev
Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants