Add instructions for hardware
This commit is contained in:
parent
7adc60a048
commit
86d8d9c74c
@ -2,8 +2,52 @@
|
||||
title: Community Examples
|
||||
---
|
||||
|
||||
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory. The file name should be the same as your username, followed by a dash, followed by the hardware form-factor. For example, `3090x1-%40dan-jan.md` would be the file name for a single 3090 GPU in a desktop form-factor.
|
||||
## Add your own example
|
||||
|
||||
Add your own examples to this page by creating a new file in the `docs/docs/hardware/examples` directory.
|
||||
|
||||
```shell
|
||||
docs
|
||||
└── docs
|
||||
└── hardware
|
||||
└── examples
|
||||
└── 3090x1-%40dan-jan.md
|
||||
└── 3090x1-%40dan-jan.md
|
||||
// highlight-next-line
|
||||
└── <YOUR_BUILD_HERE>.md
|
||||
```
|
||||
@username: hardware form-factor
|
||||
### File and Title Convention
|
||||
|
||||
We use a specific naming convention for the file name.
|
||||
|
||||
```shell
|
||||
# Filename
|
||||
<hardware-type><quantity>-<username>.md
|
||||
3090x1-@dan-jan.md # Example
|
||||
|
||||
# Title
|
||||
---
|
||||
title: <@github_username>: <hardware_x_quantity> <form-factor>
|
||||
title: @dan-jan: 3090 Desktop # Example
|
||||
---
|
||||
```
|
||||
|
||||
### Content
|
||||
|
||||
We highly recommend you include:
|
||||
|
||||
- Photos of your build
|
||||
- List of the components (e.g. [PCPartPicker](https://pcpartpicker.com))
|
||||
- Dimensions
|
||||
- Power consumption
|
||||
- Noise level
|
||||
- Any stats on token generation speeds
|
||||
- List of models you have run successfully on the build
|
||||
|
||||
## Affiliate Links
|
||||
|
||||
You are allowed to include affiliate links in your example.
|
||||
|
||||
## Longer-Term
|
||||
|
||||
We will likely build a simple web app to make it easier to add your own examples, sort and retrieve.
|
||||
@ -1,3 +1,3 @@
|
||||
---
|
||||
title: "@Dan: 3090 Desktop"
|
||||
title: "@dan-jan: 3090 Desktop"
|
||||
---
|
||||
@ -1,3 +1,3 @@
|
||||
---
|
||||
title: "@Jan: 2 x 4090 Workstation"
|
||||
title: "@janhq: 2x4090 Workstation"
|
||||
---
|
||||
@ -14,8 +14,6 @@
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
// featuresSidebar: [{ type: 'autogenerated', dirName: 'features' }],
|
||||
// hardwareSidebar: [{ type: 'autogenerated', dirName: 'hardware' }],
|
||||
aboutSidebar: [{ type: "autogenerated", dirName: "about" }],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user