Thanks @jsjoeio. In my PR (#1107) I started with a simpler structure that I think works better for the current state of the project. Here's why

➖ installation/*

Since the README.md covers the current install methods in the and there is no "simple install method," I decided to remove the installation/ section altogether until the project has more install methods. Like code-server, I think there should eventually be a install script/Docker container which is the "quickstart" and then there are other methods in the installation page.

➖ quick-start.md

The README is basically the quick start at this point.

➕ about.md

A lot of projects have an overview/about explaining why a project exists and how compares to other tools. I used the following docs as a reference:

➕ concepts.md ➖ workspaces/ ➖ templates/

Explaining templates and workspaces together seemed to make more sense when it comes to explaining variables and why templates are required, and who manages both.

Later, I think we will need dedicated pages for both to show template/workspace features. These do not exist yet and the basics are kind of covered by the README.

➕ guides/

Similar to the Coder docs, I think we need some way to have a quickstart guide on a production VM (like code-server's)

Anyways

Here's new structure I was thinking about, would love your thoughts. I may be missing something. cc @khorne3 as well. if there any sections you'd like to add/write let me know :)

coder/docs/README.md

Lines 72 to 83 in 8cb6a88

    
           - [About Coder](./about.md#about-coder) 
        
             - [Why remote development](about.md#why-remote-development) 
        
             - [Why Coder](about.md#why-coder) 
        
             - [What Coder is not](about.md#what-coder-is-not) 
        
           - Concepts 
        
             - Templates 
        
             - Workspaces 
        
             - Users and Organizations 
        
           - Guides 
        
             - Using the Coder CLI 
        
             - Install Coder on a VM with Caddy + LetsEncrypt 
        
             - Building templates in Coder

	- [About Coder](./about.md#about-coder)
	- [Why remote development](about.md#why-remote-development)
	- [Why Coder](about.md#why-coder)
	- [What Coder is not](about.md#what-coder-is-not)
	- Concepts
	- Templates
	- Workspaces
	- Users and Organizations
	- Guides
	- Using the Coder CLI
	- Install Coder on a VM with Caddy + LetsEncrypt
	- Building templates in Coder

V2 Docs #657

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions