Skip to content

docs: simpler readme + add small docs#665

Merged
wesleyboar merged 30 commits intomainfrom
docs/readme-improvements
Jul 18, 2023
Merged

docs: simpler readme + add small docs#665
wesleyboar merged 30 commits intomainfrom
docs/readme-improvements

Conversation

@wesleyboar
Copy link
Copy Markdown
Member

@wesleyboar wesleyboar commented Jun 22, 2023

Overview

Simplify the README. Add supplemental docs.

Note
I suggest reading the new README.md without the diff.

Related

Changes

  • changed /README.md to be much better
  • added /docs to hold README excess

Testing

  1. Evaluate the README.md without the diff.
  2. Read through the new files within the diff.
  3. Review docs: better readme + add small docs Core-CMS-Resources#182.

UI

N/A

@wesleyboar wesleyboar marked this pull request as ready for review June 27, 2023 04:24
@wesleyboar wesleyboar changed the title docs(README): improvements docs(README): simpler readme + add small docs Jun 27, 2023
@wesleyboar wesleyboar changed the title docs(README): simpler readme + add small docs docs(README): simpler readmes + add small docs Jun 27, 2023
@wesleyboar wesleyboar changed the title docs(README): simpler readmes + add small docs docs(README): simpler readme + add small docs Jun 27, 2023
@wesleyboar wesleyboar changed the title docs(README): simpler readme + add small docs docs: simpler readme + add small docs Jun 27, 2023
Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

@fnets fnets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know much about the non-APCD CMS sites, but this makes sense

@wesleyboar
Copy link
Copy Markdown
Member Author

I had been mimicking https://github.com/TACC/Core-Portal README format as closely as possible, but CMS is ready for its own README format, and this documentation update coincides well with https://github.com/TACC/Core-CMS/releases/tag/v3.12.0 and the deprecation of https://github.com/TACC/Core-CMS-Resources 1 and the increasing migration to https://github.com/TACC/Core-CMS-Custom 1.

Footnotes

  1. These repos have similar style README's to this PR's README. 2

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants