8000 docs: slim down readme by jsjoeio · Pull Request #2140 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

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 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 6 commits into from
Jun 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: walkthrough -> quickstart
  • Loading branch information
jsjoeio committed Jun 8, 2022
commit 9238232ed3f184b667ccf7db4d5bd12568612a7f
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m
coder server --dev
```

Use `coder --help` to get a complete list of flags and environment variables. For a full walkthrough, follow [this guide](./docs/walkthrough.md).
Use `coder --help` to get a complete list of flags and environment variables follow our [quickstart guide](./docs/quickstart.md).

## Documentation

Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
- [Why Coder](./about.md#why-coder)
- [What Coder is not](./about.md#what-coder-is-not)
- [Comparison: Coder vs. [product]](./about.md#comparison)
- [Quickstart](./quickstart.md)
- [Creating your first template and workspace](./quickstart.md#creating-your-first-template-and-workspace)
- [Modifying templates](./quickstart.md#modifying-templates)
- [Templates](./templates.md)
- [Manage templates](./templates.md#manage-templates)
- [Persistent and ephemeral
Expand Down
2 changes: 1 addition & 1 deletion docs/walkthrough.md → docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Walkthrough
# Quickstart

This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md).

Expand Down
0