jan/docs/docs/hardware/community.md
2023-09-20 21:42:13 +08:00

53 lines
1.2 KiB
Markdown

---
title: Community Examples
---
## 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
```
### 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.