add structure for dev_guide section, fix links

This commit is contained in:
Iuri Matias 2021-05-10 15:20:14 -04:00
parent b71fec3ca1
commit 80148fa3ce
39 changed files with 801 additions and 34 deletions

View File

@ -4,17 +4,11 @@
identifier = "prologue"
url = "/docs/prologue/"
[[docs]]
name = "Browser"
weight = 11
identifier = "browser"
url = "/docs/browser/"
[[docs]]
name = "Timelines"
weight = 11
identifier = "timelines"
url = "/docs/timelines/"
[[dev]]
name = "Prologue"
weight = 10
identifier = "prologue"
url = "/dev_guide/prologue/"
[[docs]]
name = "Chat"
@ -22,17 +16,47 @@
identifier = "chat"
url = "/docs/chat/"
[[dev]]
name = "Chat"
weight = 11
identifier = "chat"
url = "/dev_guide/chat/"
[[docs]]
name = "Timelines"
weight = 12
identifier = "timelines"
url = "/docs/timelines/"
[[dev]]
name = "Timelines"
weight = 12
identifier = "timelines"
url = "/dev_guide/timelines/"
[[docs]]
name = "Browser"
weight = 13
identifier = "browser"
url = "/docs/browser/"
[[dev]]
name = "Browser"
weight = 13
identifier = "browser"
url = "/dev_guide/browser/"
[[docs]]
name = "Wallet"
weight = 11
weight = 14
identifier = "wallet"
url = "/docs/wallet/"
[[dev]]
name = "Browser"
weight = 11
identifier = "browser"
url = "/dev_guide/browser/"
name = "Wallet"
weight = 14
identifier = "wallet"
url = "/dev_guide/wallet/"
[[docs]]
name = "Help"
@ -40,6 +64,12 @@
identifier = "help"
url = "/docs/help/"
[[dev]]
name = "Help"
weight = 60
identifier = "help"
url = "/dev_guide/help/"
[[main]]
name = "Docs"
url = "/docs/prologue/introduction/"
@ -47,7 +77,7 @@
[[main]]
name = "Dev Guide"
url = "/dev_guide/"
url = "/dev_guide/prologue/introduction"
weight = 11
[[main]]

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -7,7 +7,7 @@ lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
dev:
parent: "browser"
toc: true
---

View File

@ -0,0 +1,9 @@
---
title : "Chat"
description: "Status Chat"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
---

View File

@ -0,0 +1,20 @@
---
title : "Chat List"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## Search for a Chat
## Suggested Channels
## Badges
### unread message counter
### mentions @
## Context menu

View File

@ -0,0 +1,20 @@
---
title : "General"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## Actions
### Mute a chat
### Mark as Read
### Fetch Messages
### Clear History
### leaving a chat

View File

@ -0,0 +1,28 @@
---
title : "Communities"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## General
### Joining a community
### Creating a community
### Leaving a community
## Manage Community
### Creating Channels
#### Public Channels
#### Private Channels
### Transfer ownership
### Share Community
### See Members
### Kick Member
### Invite People
### Back up Community

View File

@ -0,0 +1,20 @@
---
title : "Emojis Selector"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
#### Choosing an emoji
#### Searching for an Emojis
#### Categories
#### See also
Text Input Box

View File

@ -0,0 +1,20 @@
---
title : "Group Chats"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
#### Starting a group chat
#### Group Information
#### Adding Members
#### Removing Members
#### Make other members admin
#### Renaming Group

View File

@ -0,0 +1,21 @@
---
title : "Text Input Box"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
#### mentions
#### Emojis
#### code tags
#### markdown
#### Text Formatter
#### Sending file attachments
#### special commands (e.g /shrug)

View File

@ -0,0 +1,25 @@
---
title : "Messages"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## Normal Messages
## Stickers
## Images
## URL Unfurling
### Enable Unfurling
## Reactions
## Replying to messages
## profile options
### view profile
### send message

View File

@ -0,0 +1,16 @@
---
title : "Notifications"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## notification types
## notification settings

View File

@ -0,0 +1,23 @@
---
title : "1 on 1 Chats"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## sending images
## transactions
### send transaction
### request payment
## start new 1 on 1 Chat
### with existing contact
### by ENS username
### by chat key
## join or start a public chat

View File

@ -0,0 +1,19 @@
---
title : "Stickers"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "chat"
toc: true
---
## Choosing a Sticker
### Recently used Stickers
### Sticker collections
## Getting free Stickers
## Buying a sticker pack

View File

@ -0,0 +1,9 @@
---
title: "Help"
description: "Help Doks."
lead: ""
date: 2020-10-06T08:49:15+00:00
lastmod: 2020-10-06T08:49:15+00:00
draft: false
images: []
---

View File

@ -0,0 +1,50 @@
---
title: "FAQ"
description: "Answers to frequently asked questions."
lead: "Answers to frequently asked questions."
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
images: []
menu:
dev:
parent: "help"
weight: 630
toc: true
---
## Hyas?
Doks is a [Hyas theme](https://gethyas.com/themes/) build by the creator of Hyas.
## Footer notice?
Please keep it in place.
## Keyboard shortcuts for search?
- focus: `/`
- select: `↓` and `↑`
- open: `Enter`
- close: `Esc`
## Other documentation?
- [Netlify](https://docs.netlify.com/)
- [Hugo](https://gohugo.io/documentation/)
## Can I get support?
Create a topic:
- [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions)
## Contact the creator?
Send `h-enk` a message:
- [Netlify Community](https://community.netlify.com/)
- [Hugo Forums](https://discourse.gohugo.io/)
- [Doks Discussions](https://github.com/h-enk/doks/discussions)

View File

@ -0,0 +1,32 @@
---
title: "How to Update"
description: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure."
date: 2020-11-12T13:26:54+01:00
lastmod: 2020-11-12T13:26:54+01:00
draft: false
images: []
menu:
dev:
parent: "help"
weight: 610
toc: true
---
{{< alert icon="💡" text="Learn more about <a href=\"https://docs.npmjs.com/about-semantic-versioning\">semantic versioning</a> and <a href=\"https://docs.npmjs.com/cli/v6/using-npm/semver#advanced-range-syntax\">advanced range syntax</a>." >}}
## Check for outdated packages
The [`npm outdated`](https://docs.npmjs.com/cli/v7/commands/npm-outdated) command will check the registry to see if any (or, specific) installed packages are currently outdated:
```bash
npm outdated [[<@scope>/]<pkg> ...]
```
## Update packages
The [`npm update`](https://docs.npmjs.com/cli/v7/commands/npm-update) command will update all the packages listed to the latest version (specified by the tag config), respecting semver:
```bash
npm update [<pkg>...]
```

View File

@ -0,0 +1,30 @@
---
title: "Troubleshooting"
description: "Solutions to common problems."
lead: "Solutions to common problems."
date: 2020-11-12T15:22:20+01:00
lastmod: 2020-11-12T15:22:20+01:00
draft: false
images: []
menu:
dev:
parent: "help"
weight: 620
toc: true
---
## Problems updating npm packages
Delete the `./node_modules` folder, and run again:
```bash
npm install
```
## Problems with cache
Delete the temporary directories:
```bash
npm run clean
```

View File

@ -0,0 +1,9 @@
---
title : "Prologue"
description: "Prologue Doks."
lead: ""
date: 2020-10-06T08:48:45+00:00
lastmod: 2020-10-06T08:48:45+00:00
draft: false
images: []
---

View File

@ -0,0 +1,118 @@
---
title: "Commands"
description: "Doks comes with commands for common tasks."
lead: "Doks comes with commands for common tasks."
date: 2020-10-13T15:21:01+02:00
lastmod: 2020-10-13T15:21:01+02:00
draft: false
images: []
menu:
dev:
parent: "prologue"
weight: 130
toc: true
---
{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." >}}
## create
Create new content for your site:
{{< btn-copy text="npm run create" >}}
```bash
npm run create [path] [flags]
```
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
## lint
Check scripts, styles, and markdown for errors:
{{< btn-copy text="npm run lint" >}}
```bash
npm run lint
```
### scripts
Check scripts for errors:
{{< btn-copy text="npm run lint:scripts" >}}
```bash
npm run lint:scripts [-- --fix]
```
### styles
Check styles for errors:
{{< btn-copy text="npm run lint:styles" >}}
```bash
npm run lint:styles [-- --fix]
```
### markdown
Check markdown for errors:
{{< btn-copy text="npm run lint:markdown" >}}
```bash
npm run lint:markdown [-- --fix]
```
## clean
Delete temporary directories:
{{< btn-copy text="npm run clean" >}}
```bash
npm run clean
```
## start
Start local development server:
{{< btn-copy text="npm run start" >}}
```bash
npm run start
```
## build
Build production website:
{{< btn-copy text="npm run build" >}}
```bash
npm run build
```
### functions
Build Lambda functions:
{{< btn-copy text="npm run build:functions" >}}
```bash
npm run build:functions
```
### preview
Build production website including draft and future content:
{{< btn-copy text="npm run build:preview" >}}
```bash
npm run build:preview
```

View File

@ -0,0 +1,54 @@
---
title: "Introduction"
description: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
lead: "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
date: 2020-10-06T08:48:57+00:00
lastmod: 2020-10-06T08:48:57+00:00
draft: false
images: []
menu:
dev:
parent: "prologue"
weight: 100
toc: true
---
## Get started
There are two main ways to get started with Doks:
### Tutorial
{{< alert icon="👉" text="The Tutorial is intended for novice to intermediate users." >}}
Step-by-step instructions on how to start a new Doks project. [Tutorial →](https://getdoks.org/tutorial/introduction/)
### Quick Start
{{< alert icon="👉" text="The Quick Start is intended for intermediate to advanced users." >}}
One page summary of how to start a new Doks project. [Quick Start →]({{< relref "quick-start" >}})
## Go further
Recipes, Reference Guides, Extensions, and Showcase.
### Recipes
Get instructions on how to accomplish common tasks with Doks. [Recipes →](https://getdoks.org/docs/recipes/project-configuration/)
### Reference Guides
Learn how to customize Doks to fully make it your own. [Reference Guides →](https://getdoks.org/docs/reference-guides/security/)
### Extensions
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
### Showcase
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
## Contributing
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)

View File

@ -0,0 +1,73 @@
---
title: "Quick Start"
description: "One page summary of how to start a new Doks project."
lead: "One page summary of how to start a new Doks project."
date: 2020-11-16T13:59:39+01:00
lastmod: 2020-11-16T13:59:39+01:00
draft: false
images: []
menu:
dev:
parent: "prologue"
weight: 110
toc: true
---
## Requirements
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
## Start a new Doks project
Create a new site, change directories, install dependencies, and start development server.
### Create a new site
Doks is available as a child theme, and a starter theme:
- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
Not quite sure? Use the Doks child theme.
#### Doks child theme
{{< btn-copy text="git clone https://github.com/h-enk/doks-child-theme.git my-doks-site" >}}
```bash
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
```
#### Doks starter theme
{{< btn-copy text="git clone https://github.com/h-enk/doks.git my-doks-site" >}}
```bash
git clone https://github.com/h-enk/doks.git my-doks-site
```
### Change directories
{{< btn-copy text="cd my-doks-site" >}}
```bash
cd my-doks-site
```
### Install dependencies
{{< btn-copy text="npm install" >}}
```bash
npm install
```
### Start development server
{{< btn-copy text="npm run start" >}}
```bash
npm run start
```
Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser.

View File

@ -0,0 +1,10 @@
---
title : "Timelines"
description: "Status Timelines"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
---

View File

@ -0,0 +1,13 @@
---
title : "Posting Updates"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "timelines"
toc: true
---

View File

@ -0,0 +1,19 @@
---
title : "Seeing Updates"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "timelines"
toc: true
---
## viewing updates
## fetching more updates
## default when there are no updates

View File

@ -0,0 +1,10 @@
---
title : "Wallet"
description: "Status Wallet"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
---

View File

@ -0,0 +1,18 @@
---
title : "Account Details & Balances"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---
## Assets
## Collectibles
## History
## Editing Account name & color

View File

@ -0,0 +1,14 @@
---
title : "Accounts List"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---

View File

@ -0,0 +1,18 @@
---
title : "Adding Accounts"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---
## Generating an account
## Adding a watch only address
## Adding an account using a seed phrase
## Adding an account using a private key

View File

@ -0,0 +1,14 @@
---
title : "Receiving Funds"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---

View File

@ -0,0 +1,16 @@
---
title : "Sending funds"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---
## Choosing Recipient
## Choosing Amounts, Token, gas values

View File

@ -0,0 +1,19 @@
---
title : "Wallet settings"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
dev:
parent: "wallet"
toc: true
---
## Changing currency
## Managing Tokens
### Enabling Tokens
### Disabling Tokens
### Add custom Tokens

View File

@ -52,7 +52,3 @@ See what others have build with Doks. [Showcase →](https://getdoks.org/showcas
## Contributing
Find out how to contribute to Doks. [Contributing →](https://getdoks.org/docs/contributing/how-to-contribute/)
## Help
Get help on Doks. [Help →]({{< relref "how-to-update" >}})

View File

@ -15,8 +15,6 @@ toc: true
## Requirements
Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts:
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
## Start a new Doks project
@ -73,7 +71,3 @@ npm run start
```
Doks will start the Hugo development webserver accessible by default at `http://localhost:1313`. Saved changes will live reload in the browser.
## Other commands
Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})