Skip to content

docs: update the readme to reduce unnecessary text #5837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 25, 2023
Merged

Conversation

kylecarbs
Copy link
Member

The README was starting to get quite large, and I felt it was a bit bloaty.

  • Removes Twitter badge (the API was removed, so it wasn't working anyways)
  • Adds tagline to the title (an experiment, but worth a shot)
  • Reduces highlights
  • Removes recommended reading (people want to get started asap on a repo)
  • Updates doc links /docs/coder-oss -> /docs/v2
  • Moves comparison to the bottom
  • Removes adopters.md (we never promoted this, so it hasn't been used)

The README was starting to get quite large, and I felt it was a bit bloaty.

- Removes Twitter badge (the API was removed, so it wasn't working anyways)
- Adds tagline to the title (an experiment, but worth a shot)
- Reduces highlights
- Removes recommended reading (people want to get started asap on a repo)
- Updates doc links `/docs/coder-oss` -> `/docs/v2`
- Moves comparison to the bottom
- Removes adopters.md (we never promoted this, so it hasn't been used)
@kylecarbs kylecarbs requested a review from ammario January 24, 2023 14:29
@kylecarbs kylecarbs self-assigned this Jan 24, 2023
@ammario ammario merged commit 8830ddf into main Jan 25, 2023
@ammario ammario deleted the readmeupdate branch January 25, 2023 20:49
@github-actions github-actions bot locked and limited conversation to collaborators Jan 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants