diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json index 22a15055..9b170aa8 100644 --- a/docs/.vscode/extensions.json +++ b/docs/.vscode/extensions.json @@ -1,4 +1,8 @@ { - "recommendations": ["astro-build.astro-vscode"], + "recommendations": [ + "astro-build.astro-vscode", + "hideoo.starlight-links", + "unifiedjs.vscode-mdx" + ], "unwantedRecommendations": [] } diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index aae93f91..bcb9ca86 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -48,4 +48,5 @@ export default defineConfig({ customCss: ["./src/styles/drop.css"], }), ], + site: "https://docs-next.droposs.org/" }); diff --git a/docs/src/content/docs/admin/guides/creating-library.mdx b/docs/src/content/docs/admin/guides/creating-library.mdx index 5599edca..7738f631 100644 --- a/docs/src/content/docs/admin/guides/creating-library.mdx +++ b/docs/src/content/docs/admin/guides/creating-library.mdx @@ -28,7 +28,7 @@ To import games and start using Drop, you must first create a library to import - `/mnt/media/my-drop-library` is the path to your library. - `/library` is a **unique** path inside the container. **Use something else if another volume mounts to `/library`**. - If you followed the [Quickstart](../quickstart.md) guide, you'll have already set up a library at `./library` pointing to `/library` within the container. You may want to instead edit that line in the `volumes` section to point to where your library is located. + If you followed the [Quickstart](/admin/quickstart/) guide, you'll have already set up a library at `./library` pointing to `/library` within the container. You may want to instead edit that line in the `volumes` section to point to where your library is located. 3. **Open library source interface in Admin Dashboard.** diff --git a/docs/src/content/docs/admin/guides/exposing.md b/docs/src/content/docs/admin/guides/exposing.md index 62c8ad5a..ccc3cf19 100644 --- a/docs/src/content/docs/admin/guides/exposing.md +++ b/docs/src/content/docs/admin/guides/exposing.md @@ -16,7 +16,7 @@ Drop automatically parses and formats the URL, so there are no requirements on t ## LAN -The `compose.yaml` provided in the [Quickstart guide](../quickstart.md) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use: +The `compose.yaml` provided in the [Quickstart guide](/admin/quickstart/) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use: ``` http://[instance IP]:3000 diff --git a/docs/src/content/docs/admin/metadata/manual.md b/docs/src/content/docs/admin/metadata/manual.md new file mode 100644 index 00000000..a1d7a650 --- /dev/null +++ b/docs/src/content/docs/admin/metadata/manual.md @@ -0,0 +1,5 @@ +--- +title: Manual +--- + +Metadata import can be skipped, and entered manually later. \ No newline at end of file diff --git a/docs/src/content/docs/admin/quickstart.md b/docs/src/content/docs/admin/quickstart.md index 53d3cfa2..606f4e6c 100644 --- a/docs/src/content/docs/admin/quickstart.md +++ b/docs/src/content/docs/admin/quickstart.md @@ -40,16 +40,9 @@ services: **The main things in this `compose.yaml` is the volumes attached to the `drop` service:** -1. `./library` is where you will put your games to be imported into Drop. See '[Structuring your library](../library.md#structuring-your-library)' once you're set up. +1. `./library` is where you will put your games to be imported into Drop. See '[Creating a library](/admin/guides/creating-library/)' once you're set up. 2. `./data` is where Drop will store anything that's using the default file-system backed storage system. Typically, these are objects. -**In addition, configure your chosen metadata provider:** - -- [GiantBomb](../metadata/giantbomb.md) -- [IGDB](../metadata/igdb.md) -- [PCGamingWiki](../metadata/pcgamingwiki.md) -- Manual - you can import games without metadata and enter it yourself. - :::tip If you want to, you can generate a more secure PostgreSQL username & password. ::: diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 224745d5..0bf38893 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -2,7 +2,7 @@ title: Welcome to Drop description: Welcome to the Drop OSS project documentation. hero: - tagline: Congrats on setting up a new Starlight project! + tagline: Welcome to the Drop OSS project documentation. image: file: ../../assets/houston.webp actions: diff --git a/docs/src/content/docs/reference/library-sources.mdx b/docs/src/content/docs/reference/library-sources.mdx index a83ef841..4abd4184 100644 --- a/docs/src/content/docs/reference/library-sources.mdx +++ b/docs/src/content/docs/reference/library-sources.mdx @@ -48,7 +48,7 @@ In the UI, you'll be prompted to "import" each folder separately: So your game has gotten an update and you've got new files. All you need to do is create a new version folder inside the game folder, and move all the files you have into that folder. Then, import it within the Drop admin UI. -If you have files that you're supposed to **paste over the previous version**, Drop supports that! Read [Update mode](./update-mode.mdx) to find out more. +If you have files that you're supposed to **paste over the previous version**, Drop supports that! Read [Update mode](/reference/update-mode/) to find out more. # Compatibility (flat-style)