From d04d527f2cb3d9e7a0776332d79883a3a8ad6a25 Mon Sep 17 00:00:00 2001 From: Bruno Quaresma Date: Thu, 9 Jun 2022 13:46:16 -0500 Subject: [PATCH] chore: Update docs manifest home page and icons (#2133) * chore: Update docs manifest home page and icons * RRemove contributors * Update template icon * fixup: manifest.json changes * fix: add missing readme to root * fix: add readme to /docs with toc * fix: add quickstart to manifest Co-authored-by: Joe Previte --- docs/README.md | 23 +++++++++++++++++++++++ docs/manifest.json | 33 ++++++++++++++++++++++----------- 2 files changed, 45 insertions(+), 11 deletions(-) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..e01b58e5fa --- /dev/null +++ b/docs/README.md @@ -0,0 +1,23 @@ +# Coder Documentation + +## Table of Contents + +- [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) + - [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 + resources](./templates.md#persistent-and-ephemeral-resources) + - [Parameters](./templates.md#parameters) +- [Workspaces](./workspaces.md) + - [Create workspaces](./workspaces.md#create-workspaces) + - [Connect with SSH](./workspaces.md#connect-with-ssh) + - [Editors and IDEs](./workspaces.md#editors-and-ides) + - [Workspace lifecycle](./workspaces.md#workspace-lifecycle) + - [Updating workspaces](./workspaces.md#updating-workspaces) diff --git a/docs/manifest.json b/docs/manifest.json index fae42e290d..b75b003dc5 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,30 +1,46 @@ { "versions": ["0.6.2"], "routes": [ + { + "title": "Home", + "description": "How to install and run Coder", + "path": "./README.md", + "icon": "" + }, { "title": "About", "description": "About Coder", - "path": "./about.md" + "path": "./about.md", + "icon": "" }, { "title": "Installation", - "description": "Learn how to install and deploy Coder.", + "description": "How to install and deploy Coder", + "icon": "", "path": "./install.md" }, + { + "title": "Quickstart", + "description": "Create your first template and workspace", + "icon": "", + "path": "./quickstart.md" + }, { "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces.", "path": "./templates.md", - "icon": "" + "icon": " " }, { "title": "Workspaces", "description": "Learn about Coder workspaces.", + "icon": "\n\n\n", "path": "./workspaces.md" }, { "title": "Contributing", "description": "Learn how to contribute to Coder.", + "icon": "", "path": "./CONTRIBUTING.md", "children": [ { @@ -33,16 +49,11 @@ "path": "./CODE_OF_CONDUCT.md" }, { - "title": "Contributors", - "description": "See a contributors to Coder.", - "path": "./CONTRIBUTORS.md" + "title": "Security policy", + "description": "How to report vulnerabilities in Coder", + "path": "./SECURITY.md" } ] - }, - { - "title": "Security policy", - "description": "Learn how to report vulnerabilities in Coder.", - "path": "./SECURITY.md" } ] }