-
Notifications
You must be signed in to change notification settings - Fork 353
Transition most text README files to markdown or restructured text format so will be visualized in github/VS code #2761
Copy link
Copy link
Open
Documentation
Copy link
Labels
bfbbit-for-bitbit-for-bitdocs-loc:codebaseRelates to documentation within the CTSM code. E.g., Readmes, code comments or tool help text.Relates to documentation within the CTSM code. E.g., Readmes, code comments or tool help text.docs:updateSignificant update or fix needed to existing documentationSignificant update or fix needed to existing documentationdocumentationadditions or edits to user-facing documentation or its infrastructureadditions or edits to user-facing documentation or its infrastructureenhancementnew capability or improved behavior of existing capabilitynew capability or improved behavior of existing capabilitytest: noneNo tests required (e.g. tools/contrib)No tests required (e.g. tools/contrib)usabilityImprove or clarify user-facing optionsImprove or clarify user-facing options
Milestone
Metadata
Metadata
Assignees
Labels
bfbbit-for-bitbit-for-bitdocs-loc:codebaseRelates to documentation within the CTSM code. E.g., Readmes, code comments or tool help text.Relates to documentation within the CTSM code. E.g., Readmes, code comments or tool help text.docs:updateSignificant update or fix needed to existing documentationSignificant update or fix needed to existing documentationdocumentationadditions or edits to user-facing documentation or its infrastructureadditions or edits to user-facing documentation or its infrastructureenhancementnew capability or improved behavior of existing capabilitynew capability or improved behavior of existing capabilitytest: noneNo tests required (e.g. tools/contrib)No tests required (e.g. tools/contrib)usabilityImprove or clarify user-facing optionsImprove or clarify user-facing options
Type
Projects
Status
Done
Status
In review
Many of our README files are in raw text format. Since github will visualize markdown or restructured text, we should update them to one of those formats. Which will make them easier to read on either github or VS code, but still readable in raw text format. This will make URL's proper links and issue or PR's links as well.