Update wiki to docs

2026-04-23 06:54:41 +00:00 · 2025-09-18 10:05:48 -04:00
parent d389b8c81e
commit f1d93268a9
7 changed files with 10 additions and 10 deletions
@@ -1,9 +1,9 @@
 <svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="1280" height="640" preserveAspectRatio="none" viewBox="0 0 1280 640"><path fill="#60a5fa" d="M-82-22h1440v732H-82Z" style="display:inline;stroke-width:1.14331"/><path d="m714.366 256.564-458.44 458.44v53.536H767.82V256.564Z" class="background-dark" clip-path="url(#a)" style="display:inline;fill:#3b82f6;fill-opacity:1;stroke-width:0" transform="rotate(180 731.605 739.433)scale(2.39997)"/><path fill="#fab560" d="M1358 1104c100 30 230 40 310-40s30-210 70-310c35-90 130-150 140-240 10-100-10-220-90-290s-200-40-300-60c-90-20-180-60-270-30s-150 110-220 170c-70 70-190 120-200 220s110 160 170 240c50 70 90 130 150 180 70 60 140 140 230 160" style="display:inline"/><g style="display:inline"><path d="M255.928 256.564H767.82V768.54H255.928Z" class="background-light" clip-path="url(#b)" style="display:inline;fill:#f5f6f7;fill-opacity:1;stroke-width:0" transform="matrix(.8 0 0 .8 -77.506 -87.483)"/><path d="m714.366 256.564-458.44 458.44v53.536H767.82V256.564Z" class="background-dark" clip-path="url(#b)" style="display:inline;fill:#e8e9eb;fill-opacity:1;stroke-width:0" transform="matrix(.8 0 0 .8 -77.506 -87.483)"/><g clip-path="url(#c)" style="display:inline" transform="translate(127.204 117.746)scale(1.51181)"><path d="M601.91 768.54c-2.735-.066-43.37-47.717-83.736-79.261-2.784-2.176-6.65-5.2-8.593-6.721-3.886-3.045-10.784-7.06-11.479-7.461-1.19-.687-2.393-1.272-6.665-3.15-4.524-1.99-13.567-4.542-18.772-5.298-8.498-1.236-33.84-1.639-96.251-1.582l-120.486.11c-.016-82.184-.01-236.036-.013-305.108l88.831.232c39.029.101 40.847-.189 47.144-3.008 13.443-6.019 68.906-76.53 83.114-82.973 7.254-3.29 16.603-4.702 23.918-3.202 1.581.324 6.626 1.157 11.212 1.852 10.895 1.65 18.218 2.754 35.434 7.376 28.676 7.697 56.638 19.386 58.66 20.31 11.937 5.453 25.411 12.472 29.43 16.271 1.59 1.504 3.282 3.542 4.083 4.852 3.524 5.765 11.034 19.845 11.756 22.333 9.175 22.007 17.356 44.381 25.733 66.7 3.979 11.415 8.336 22.57 12.276 33.945 3.358 9.785 10.614 30.128 11.045 30.968 5.604 15.717 10.419 31.655 15.204 47.643 2.989 9.93 6.674 22.862 10.253 36.626 5.39 18.118 10.909 36.205 14.226 54.889.718 3.96 3.264 19.802 3.445 21.053.437 3.026 3.277 25.867 3.851 31.073 2.626 23.81 2.15 68.545-17.678 101.54-.1.167-2.65.031-2.707.032-9.042.065-31.907-.03-39.664-.043-15.94-.029-83.501.005-83.508.005z" class="logo-secondary" style="display:inline;fill:#3b82f6;fill-opacity:1;stroke-width:0;stroke-dasharray:none" transform="translate(-135.407 -135.75)scale(.52916)"/><path d="M115.894 9.256c-7 3.173-37.415 41.18-43.992 44.125-3.331 1.492-4.294 1.645-24.947 1.591l-46.94-.189c0 36.55-.002 117.963.006 161.45l26.456-.023L204.26 38.36c-.75-1.387-1.84-3.095-2.388-3.99-.424-.694-1.18-1.633-2.021-2.428-2.126-2.01-9.256-5.725-15.573-8.61-10.144-4.633-20.204-7.68-31.041-10.748-9.11-2.446-17.249-3.626-18.752-3.903-2.413-.444-5.031-.84-5.932-.98-.641-.098-6.525-1.225-12.658 1.555z" class="logo-primary" style="fill:#60a5fa;fill-opacity:1;stroke-width:0"/><g clip-path="url(#d)" style="display:inline" transform="translate(-135.407 -135.75)scale(.52916)"><circle cx="530.532" cy="381.817" r="31.529" class="dot-light" style="fill:#f5f6f7;fill-opacity:1;stroke-width:0;stroke-linejoin:bevel;stroke-dasharray:none"/><circle cx="471.565" cy="440.348" r="31.529" class="dot-light" style="fill:#f5f6f7;fill-opacity:1;stroke-width:0;stroke-linejoin:bevel;stroke-dasharray:none"/><circle cx="590.601" cy="439.252" r="31.529" class="dot-dark" style="fill:#e8e9eb;fill-opacity:1;stroke-width:0;stroke-linejoin:bevel;stroke-dasharray:none"/><circle cx="530.441" cy="499.948" r="31.529" class="dot-dark" style="fill:#e8e9eb;fill-opacity:1;stroke-width:0;stroke-linejoin:bevel;stroke-dasharray:none"/></g></g></g><defs><clipPath id="b" clipPathUnits="userSpaceOnUse"><ellipse cx="511.875" cy="512.551" rx="255.946" ry="255.984" style="fill:none"/></clipPath><clipPath id="c" clipPathUnits="userSpaceOnUse"><ellipse cx="135.457" cy="135.471" rx="135.436" ry="135.456" style="fill:none"/></clipPath><clipPath id="d" clipPathUnits="userSpaceOnUse"><ellipse cx="511.875" cy="512.551" rx="255.946" ry="255.984" style="fill:none"/></clipPath><clipPath id="a" clipPathUnits="userSpaceOnUse"><ellipse cx="511.875" cy="512.551" rx="255.946" ry="255.984" style="fill:none"/></clipPath></defs><text xml:space="preserve" x="697.047" y="480.852" style="font-style:normal;font-variant:normal;font-weight:400;font-stretch:normal;font-size:48px;line-height:0;font-family:Calibri;-inkscape-font-specification:Calibri;text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#3b82f6;fill-opacity:1;stroke-width:3.375">
-    <tspan x="697.047" y="480.852" style="font-style:normal;font-variant:normal;font-weight:700;font-stretch:normal;font-size:48px;line-height:0;font-family:Calibri;-inkscape-font-specification:&quot;Calibri Bold&quot;;fill:#fff;fill-opacity:1;stroke-width:3.375">rommapp/wiki</tspan>
+    <tspan x="697.047" y="480.852" style="font-style:normal;font-variant:normal;font-weight:700;font-stretch:normal;font-size:48px;line-height:0;font-family:Calibri;-inkscape-font-specification:&quot;Calibri Bold&quot;;fill:#fff;fill-opacity:1;stroke-width:3.375">rommapp/docs</tspan>
  </text><path d="M629.609 424.4c-21.951 0-39.609 17.82-39.609 39.852 0 17.658 11.34 32.562 27.054 37.827 1.944.405 2.673-.891 2.673-1.944 0-.891-.081-4.131-.081-7.371-11.016 2.349-13.284-4.779-13.284-4.779-1.782-4.617-4.374-5.832-4.374-5.832-3.564-2.43.243-2.43.243-2.43 3.969.243 6.075 4.131 6.075 4.131 3.564 6.075 9.234 4.374 11.502 3.321.324-2.592 1.377-4.374 2.511-5.346-8.748-.891-17.982-4.374-17.982-19.683 0-4.374 1.539-7.938 4.05-10.692-.405-.972-1.782-5.103.405-10.53 0 0 3.321-1.053 10.854 4.131 3.159-.891 6.561-1.296 9.882-1.296s6.723.486 9.882 1.296c7.533-5.184 10.854-4.131 10.854-4.131 2.187 5.508.81 9.558.405 10.53 2.592 2.754 4.05 6.318 4.05 10.692 0 15.309-9.234 18.711-18.063 19.683 1.458 1.215 2.673 3.645 2.673 7.371 0 5.346-.081 9.639-.081 10.935 0 1.053.729 2.349 2.673 1.944 15.795-5.265 27.135-20.169 27.135-37.827.081-22.032-17.658-39.852-39.447-39.852" style="fill:#fff;stroke-width:.81"/><text xml:space="preserve" x="588.099" y="355.512" style="font-style:normal;font-variant:normal;font-weight:400;font-stretch:normal;font-size:53.3333px;line-height:0;font-family:Calibri;-inkscape-font-specification:Calibri;text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#3b82f6;fill-opacity:1;stroke-width:3.375">
    <tspan x="588.099" y="355.512" style="font-style:normal;font-variant:normal;font-weight:700;font-stretch:normal;font-size:53.3333px;line-height:0;font-family:Calibri;-inkscape-font-specification:&quot;Calibri Bold&quot;;fill:#fff;fill-opacity:1;stroke-width:3.375">documentation for RomM.</tspan>
  </text><text xml:space="preserve" x="589.494" y="296.458" style="font-style:normal;font-variant:normal;font-weight:400;font-stretch:normal;font-size:53.3333px;line-height:0;font-family:Calibri;-inkscape-font-specification:Calibri;text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#3b82f6;fill-opacity:1;stroke-width:3.375">
    <tspan x="589.494" y="296.458" style="font-style:normal;font-variant:normal;font-weight:700;font-stretch:normal;font-size:53.3333px;line-height:0;font-family:Calibri;-inkscape-font-specification:&quot;Calibri Bold&quot;;fill:#fff;fill-opacity:1;stroke-width:3.375">Beautiful, powerful,</tspan>
  </text><text xml:space="preserve" x="582.656" y="207.396" style="font-style:normal;font-variant:normal;font-weight:400;font-stretch:normal;font-size:106.667px;line-height:0;font-family:Calibri;-inkscape-font-specification:Calibri;text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#3b82f6;fill-opacity:1;stroke-width:3.375">
    <tspan x="582.656" y="207.396" style="font-style:normal;font-variant:normal;font-weight:700;font-stretch:normal;font-size:106.667px;line-height:0;font-family:Calibri;-inkscape-font-specification:&quot;Calibri Bold&quot;;fill:#fff;fill-opacity:1;stroke-width:3.375">RomM Docs</tspan>
-  </text></svg>
+  </text></svg>
@@ -46,7 +46,7 @@ response to any behavior that they deem inappropriate, threatening, offensive,
 or harmful.

 Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
+comments, commits, code, docs edits, issues, and other contributions that are
 not aligned to this Code of Conduct, and will communicate reasons for moderation
 decisions when appropriate.

@@ -32,7 +32,7 @@ Join us on Discord, where you can ask questions, submit ideas, get help, showcas

 <!-- Badges -->

-[license-badge-img]: https://img.shields.io/github/license/rommapp/wiki?style=for-the-badge&color=a32d2a
+[license-badge-img]: https://img.shields.io/github/license/rommapp/docs?style=for-the-badge&color=a32d2a
 [license-badge]: LICENSE
 [discord-badge-img]: https://img.shields.io/badge/discord-7289da?style=for-the-badge
 [discord-badge]: https://discord.gg/P5HtHnhUDH
@@ -40,7 +40,7 @@ mkdir -p /volume1/data/media/games/library/roms
 mkdir -p /volume1/data/media/games/library/bios
 ```

-Note: For supported platforms and their specific folder names, refer to the [official RomM wiki](../Platforms-and-Players/Supported-Platforms.md).
+Note: For supported platforms and their specific folder names, refer to the [official RomM docs](../Platforms-and-Players/Supported-Platforms.md).

 #### Docker Data Folders

@@ -72,7 +72,7 @@ Save the output - you'll need it for the `ROMM_AUTH_SECRET_KEY` in your configur

 #### API Integration Setup

-Follow the dedicated wiki page for [API key generation](../Getting-Started/Metadata-Providers.md) to set up your API keys.
+Follow the dedicated docs page for [API key generation](../Getting-Started/Metadata-Providers.md) to set up your API keys.

 ### 4. MariaDB Configuration

@@ -116,4 +116,4 @@ Create a `docker-compose.yml` file with the following content:

 ## Contributing

-This guide is an abridged version of ChopFoo's original guide. If you have any suggestions or improvements, please submit a pull request to the [RomM wiki](https://github.com/rommapp/wiki).
+This guide is an abridged version of ChopFoo's original guide. If you have any suggestions or improvements, please submit a pull request to the [RomM docs](https://github.com/rommapp/docs).
@@ -71,4 +71,4 @@ In my particular setup, I had to create a user/group in TrueNAS with uid:gid of

 ## Contributing

-If you have any suggestions or improvements, please submit a pull request to the [RomM wiki](https://github.com/rommapp/wiki).
+If you have any suggestions or improvements, please submit a pull request to the [RomM docs](https://github.com/rommapp/docs).
@@ -1,5 +1,5 @@
 [project]
-name = "wiki"
+name = "romm-docs"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
@@ -805,7 +805,7 @@ wheels = [
 ]

 [[package]]
-name = "wiki"
+name = "romm-docs"
 version = "0.1.0"
 source = { virtual = "." }
 dependencies = [