- Notifications
You must be signed in to change notification settings - Fork1k
docs: slim down readme#2140
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Keep it short and simple.
| ##Getting Started | ||
| ##Installing Coder | ||
| >**Note**: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Important, but they don't need to know this until they go to install and use it.
| - 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I called itindex.md because that was what first came to mind. Open to other suggestions.
| --- | ||
| _As of 5/27/22_ | ||
| _Last updated: 5/27/22_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Felt like this was easier to understand
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
All these changes look good to me, I added some suggestions.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
| <palign="center"> | ||
| <imgsrc="./docs/images/ide-icons.svg"height=72> | ||
| </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I like the second idea!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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
Uh oh!
There was an error while loading.Please reload this page.
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