docs: slim down readme #2140
docs: slim down readme #2140
Conversation
|
|
||
| > **Note**: | ||
| > Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose). | ||
| Coder creates remote development machines so your team can develop from anywhere. |
There was a problem hiding this comment.
Keep it short and simple.
|
|
||
| ## Installing Coder | ||
| > **Note**: |
There was a problem hiding this comment.
Important, but they don't need to know this until they go to install and use it.
| **Manage less** | ||
|
|
||
| - Ensure your entire team is using the same tools and resources | ||
| - Rollout critical updates to your developers with one command | ||
| - Automatically shut down expensive cloud resources | ||
| - Keep your source code and data behind your firewall | ||
|
|
||
| ## How it works |
There was a problem hiding this comment.
Diff is hard to read. I just moved these down a bit.
| Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder! | ||
|
|
||
| [Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) | ||
| Visit our docs [here](./docs/index.md). |
There was a problem hiding this comment.
I called it index.md because that was what first came to mind. Open to other suggestions.
| @@ -155,7 +72,13 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa | |||
|
|
|||
| --- | |||
|
|
|||
| _As of 5/27/22_ | |||
| _Last updated: 5/27/22_ | |||
There was a problem hiding this comment.
Felt like this was easier to understand
| <p align="center"> | ||
| <img src="./docs/images/ide-icons.svg" height=72> | ||
| </p> |
There was a problem hiding this comment.
While it does take up some scrolling space, we've received some early feedback that the IDE/cloud icons helped explain what Coder does. Do you think these make the README more confusing?
There was a problem hiding this comment.
hmm... When we use a product screenshot, we can attempt to include the use of the IDE icons and clouds there
There was a problem hiding this comment.
I like the second idea!
There was a problem hiding this comment.
we've received some early feedback that the IDE/cloud icons helped explain what Coder does
I agree with this, but it also makes me wonder, does our copy not convey this already? It probably should! aka the IDE/Cloud icons should be additive and shouldn't be necessary to explain Coder.
* docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
Description
This PR refactors the
README.mdto be more slim and concise with the goal of making it less overwhelming when someone lands on the repo page.I also moved the Documentation Table of Contents to
./docs/index.mdand some getting started information to./docs/walkthrough.md. Open to suggestions!🖼️ Rendered