diff --git a/docs/docs/hardware/community.md b/docs/docs/hardware/community.md index 6030f0eb5..d0791a1a9 100644 --- a/docs/docs/hardware/community.md +++ b/docs/docs/hardware/community.md @@ -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 + └── .md ``` -@username: hardware form-factor -``` \ No newline at end of file +### File and Title Convention + +We use a specific naming convention for the file name. + +```shell +# Filename +-.md +3090x1-@dan-jan.md # Example + +# Title +--- +title: <@github_username>: +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. \ No newline at end of file diff --git a/docs/docs/hardware/concepts/apple-silicon.md b/docs/docs/hardware/concepts/apple-silicon.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/docs/hardware/examples/3090x1-@dan-jan.md b/docs/docs/hardware/examples/3090x1-@dan-jan.md index 58400c21a..81a665357 100644 --- a/docs/docs/hardware/examples/3090x1-@dan-jan.md +++ b/docs/docs/hardware/examples/3090x1-@dan-jan.md @@ -1,3 +1,3 @@ --- -title: "@Dan: 3090 Desktop" +title: "@dan-jan: 3090 Desktop" --- \ No newline at end of file diff --git a/docs/docs/hardware/examples/4090x2-@dan-jan.md b/docs/docs/hardware/examples/4090x2-@dan-jan.md index 318e48e17..20876d7ee 100644 --- a/docs/docs/hardware/examples/4090x2-@dan-jan.md +++ b/docs/docs/hardware/examples/4090x2-@dan-jan.md @@ -1,3 +1,3 @@ --- -title: "@Jan: 2 x 4090 Workstation" +title: "@janhq: 2x4090 Workstation" --- \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 6c1377d82..a076921ca 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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