11# Docs
22
3- Self-serve documentation is a critical part of any technical product. Beyond current users, docs are an important
4- evaluation tool for prospective users.
3+ Self-serve documentation is a critical part of any technical product. Beyond current users, docs are
4+ an important evaluation tool for prospective users.
55
66## Source Control
77
8- Our docs are maintained in markdown files in this repo. All changes are managed through a code-first release flow.
8+ Our docs are maintained in markdown files in this repo. All changes are managed through a code-first
9+ release flow.
910
1011## Hosting
1112
12- The design and hosting of our site is provided by [ Mintlify] ( https://mintlify.com/ ) . The vast majority of configuration
13- is in code in ` mint.json ` .
13+ The design and hosting of our site is provided by [ Mintlify] ( https://mintlify.com/ ) . The vast
14+ majority of configuration is in code in ` mint.json ` .
1415
15- Changes will be deployed to [ production] ( https://docs.hypermode.com ) automatically after pushing to the ` main ` branch.
16+ Changes will be deployed to [ production] ( https://docs.hypermode.com ) automatically after pushing to
17+ the ` main ` branch.
1618
1719## Development Environment Setup
1820
@@ -48,8 +50,8 @@ npm i -g @trunkio/launcher
4850
4951## Writing
5052
51- Mintlify includes a [ number of components] ( https://mintlify.com/docs/content/components/accordions ) to make it easier to
52- build easy-to-consume documentation.
53+ Mintlify includes a [ number of components] ( https://mintlify.com/docs/content/components/accordions )
54+ to make it easier to build easy-to-consume documentation.
5355
5456To spin up a local server, run the following command at the root of the docs repo:
5557
@@ -59,31 +61,33 @@ mintlify dev
5961
6062### Style
6163
62- Consistency is important in any documentation experience. Beyond Markdown’s opinionated structure, we adhere to a
63- consistent style for Hypermode.
64+ Consistency is important in any documentation experience. Beyond Markdown’s opinionated structure,
65+ we adhere to a consistent style for Hypermode.
6466
65- We have adopted [ Google’s Developer Documentation Style Guide] ( https://developers.google.com/style/ ) as a baseline, with
66- Hypermode-specific terms [ stored in a vocabulary file] ( ./styles/config/vocabularies/general/accept.txt ) .
67+ We have adopted [ Google’s Developer Documentation Style Guide] ( https://developers.google.com/style/ )
68+ as a baseline, with Hypermode-specific terms
69+ [ stored in a vocabulary file] ( ./styles/config/vocabularies/general/accept.txt ) .
6770
68- [ Vale] ( https://vale.sh/ ) has been implemented in the repo for easy alignment. Vale is implemented within CI/CD, but also
69- executable locally with:
71+ [ Vale] ( https://vale.sh/ ) has been implemented in the repo for easy alignment. Vale is implemented
72+ within CI/CD, but also executable locally with:
7073
7174``` bash
7275vale --glob=' *.{mdx}' *
7376```
7477
75- A [ Vale VS Code extension] ( https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode ) is also
76- available, and is included in the recommended extensions for this repo.
78+ A
79+ [ Vale VS Code extension] ( https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode )
80+ is also available, and is included in the recommended extensions for this repo.
7781
7882### Iconography
7983
80- When icons are required, select from [ Font Awesome] ( https://fontawesome.com/icons ) ’s catalog for easy rendering with
81- Mintlify.
84+ When icons are required, select from [ Font Awesome] ( https://fontawesome.com/icons ) ’s catalog for
85+ easy rendering with Mintlify.
8286
8387### Formatting and Linting
8488
85- Trunk has been implemented for easy formatting and linting across different file types. It is implemented within CI/CD,
86- but also executable locally.
89+ Trunk has been implemented for easy formatting and linting across different file types. It is
90+ implemented within CI/CD, but also executable locally.
8791
8892To format the repo locally, run:
8993
@@ -97,10 +101,11 @@ To run lint checks, run:
97101trunk check # appending --all will run checks beyond changes on the current branch
98102```
99103
100- Note that Trunk also has a [ VS Code extension ] ( https://marketplace.visualstudio.com/items?itemName=Trunk.io ) you can
101- install.
104+ Note that Trunk also has a
105+ [ VS Code extension ] ( https://marketplace.visualstudio.com/items?itemName=Trunk.io ) you can install.
102106
103- However, when installing it please be aware of the ` trunk.autoInit ` setting, which is ` true ` (enabled) by default This
104- controls whether to auto-initialize trunk in non-trunk repositories - meaning _ any_ folder you open with VS Code will
105- get configured with a ` .trunk ` subfolder, and will start using Trunk. You should probably set this to ` false ` in your VS
106- Code user settings, to not interfere with other projects you may be working on.
107+ However, when installing it please be aware of the ` trunk.autoInit ` setting, which is ` true `
108+ (enabled) by default This controls whether to auto-initialize trunk in non-trunk repositories -
109+ meaning _ any_ folder you open with VS Code will get configured with a ` .trunk ` subfolder, and will
110+ start using Trunk. You should probably set this to ` false ` in your VS Code user settings, to not
111+ interfere with other projects you may be working on.
0 commit comments