Skip to content

Commit c245098

Browse files
committed
docs: fix < in the readme
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
1 parent c2f1b92 commit c245098

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

contributing-guides/contribute-to-the-siderolabs-docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,14 @@ To update an existing file:
9595
To add a new page to the docs:
9696
9797
1. Create a new MDX file in the appropriate folder:
98-
* Talos (versioned): `public/talos/&lt;version>/&lt;section>/your-page.mdx`
99-
* Omni: `public/omni/&lt;section>/your-page.mdx`
100-
* Kubernetes Guides: `public/kubernetes-guides/&lt;section>/your-page.mdx`
98+
* Talos (versioned): `public/talos/<version>/<section>/your-page.mdx`
99+
* Omni: `public/omni/<section>/your-page.mdx`
100+
* Kubernetes Guides: `public/kubernetes-guides/<section>/your-page.mdx`
101101
2. Add the new page to the sidebar. Mintlify doesn’t automatically detect new pages.
102102
103103
To make your new page visible in the sidebar, add the file path of the new page to the correct YAML file:
104104
105-
* Talos → `talos-v&lt;version>.yaml`
105+
* Talos → `talos-v<version>.yaml`
106106
* Omni → `omni.yaml`
107107
* Kubernetes Guides → `kubernetes-guides.yaml`
108108
3. Once your YAML is updated, rebuild the master `docs.json` file by running:
@@ -137,7 +137,7 @@ Once you have verified that everything looks good, commit your changes:
137137
138138
```bash
139139
git add .
140-
git commit -m "docs: improve &lt;topic> section"
140+
git commit -m "docs: improve <topic> section"
141141
git push -u origin HEAD
142142
```
143143

0 commit comments

Comments
 (0)