task: adding the pages

paganotoni · Jan 17, 2024 · 8c3d9a0 · 8c3d9a0
1 parent a821019
commit 8c3d9a0
Show file tree

Hide file tree

Showing 13 changed files with 17 additions and 45 deletions.
diff --git a/docs/customization/_meta.md b/docs/customization/_meta.md
@@ -0,0 +1,3 @@
+---
+index: 2
+---
diff --git a/docs/customization/announcement.md b/docs/customization/announcement.md
diff --git a/docs/customization/copy.md b/docs/customization/copy.md
diff --git a/docs/customization/external_links.md b/docs/customization/external_links.md
diff --git a/docs/customization/github_link.md b/docs/customization/github_link.md
diff --git a/docs/customization/logo.md b/docs/customization/logo.md
diff --git a/docs/customization/meta_file.md b/docs/customization/meta_file.md
diff --git a/docs/customization/navigation.md b/docs/customization/navigation.md
diff --git a/docs/customization/search.md b/docs/customization/search.md
diff --git a/docs/getting_started/anatomy_of_doco.md b/docs/getting_started/anatomy_of_doco.md
@@ -0,0 +1,3 @@
+---
+title: Anatomy of Doco
+---
diff --git a/docs/getting_started/development_setup.md b/docs/getting_started/development_setup.md
diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md
@@ -2,41 +2,30 @@
 title: Getting Started
 index: 1
 ---
+Doco is delivered as a self-contained binary, making its usage and integration straightforward. The first step in utilizing Doco's full potential is to install this binary, which enables access to all its features, from converting markdown files to integrating with continuous integration workflows. This binary-focused approach ensures a streamlined and efficient user experience.
 
-Doco is a documentation website generator for your projects written in Go. It takes a folder with markdown files and generates a deployable static website.
-
-## Features
-
-- Markdown based
-- Generated Navigation
-- Responsive Website
-- Syntax highlighting
-- Quick Search widget
-
-## Installation
-To install Doco you can do it with the go tool or download the binary from the [releases page]().
-
-### Install using Go
+## Installing
+To install Doco you can do it with the go tool or download the binary from the releases page.
 
 ```go
 go install github.com/paganotoni/doco@latest
 ```
-### Download binary
-You can download the binary from the [releases page]() and pick the one that matches your OS and architecture.
 
-## Usage
+## Initializing the documentation folder
 Once the tool is installed you can run the following command to initialize the documentation folder:
 
 ```sh
 doco init
 ```
 
-This, based on the `docs` folder with a few basic files:
+This, will create the `docs` folder with a few files:
 
 - _meta.md
+- index.md
 - getting_started/getting_started.md
-- getting_started/development.md
-- getting_started/faq.md
+
+
+## Build the website
 
 Once the folder is initialized you can run the following command to generate the static website:
 
@@ -45,24 +34,3 @@ doco build
 ```
 
 This will generate the static website in the `site` folder. You can then deploy the static website to your favorite hosting provider.
-
-### the `_meta` file
-
-The `_meta` file is a markdown file that contains the metadata for the documentation website. It is used to generate the header links as well as configuring general features such as the search widget.
-
-### markdown files
-
-Each of the markdown files in the `docs` folder will be a page in the documentation website. The folder structure will be used to generate the navigation. However, you can configure the name of these files by adding a `title` metadata to the markdown file. You can also use the `weight` metadata to configure the order of the pages in the navigation menu. Files can be excluded from the navigation by using the `draft` property on them.
-
-A typical markdown file will look like this:
-
-```md
---- 
-title: Getting Started
-weight: 1
-draft: false
----
-
-# Getting Started
-...
-```
diff --git a/docs/index.md b/docs/index.md
@@ -10,4 +10,5 @@ With user-friendly features like sidebar navigation and a search component, Doco
 
 ![Doco Preview](assets/preview.png "Preview of Doco")
 
-To get started go to the [getting started](/getting_started/getting_started.html) section.
+**Next**:
+[Getting Started](/getting_started/getting_started.html)