Skip to content

Transition most text README files to markdown or restructured text format so will be visualized in github/VS code #2761

@ekluzek

Description

@ekluzek

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.

Metadata

Metadata

Assignees

Labels

bfbbit-for-bitdocs-loc:codebaseRelates to documentation within the CTSM code. E.g., Readmes, code comments or tool help text.docs:updateSignificant update or fix needed to existing documentationdocumentationadditions or edits to user-facing documentation or its infrastructureenhancementnew capability or improved behavior of existing capabilitytest: noneNo tests required (e.g. tools/contrib)usabilityImprove or clarify user-facing options

Projects

Status

Done

Status

In review

Relationships

None yet

Development

No branches or pull requests

Issue actions