fix: deduplicate docs with new check script

Author: DecDuck

check.js

@@ -0,0 +1,54 @@
+/**
+ * A lot of these docs are copy-pasted and modified, and I may miss things as I write them.
+ * This script is designed to catch these errors.
+ */
+
+import fs from 'fs'
+import { micromark } from 'micromark'
+import { mdx } from 'micromark-extension-mdx'
+import { parse } from 'node-html-parser'
+import path from 'path'
+
+function findFiles(dir) {
+  const files = fs.readdirSync(dir)
+  let results = []
+  for (const file of files) {
+    const abs = path.join(dir, file)
+    if (fs.statSync(abs).isDirectory()) {
+      results.push(...findFiles(abs))
+    } else if (abs.endsWith('.mdx')) {
+      results.push(abs)
+    }
+  }
+  return results
+}
+
+const mdxs = findFiles('./src')
+
+const whitelist = [
+  'export const metadata',
+  'Not required for this example.',
+  "The above ACL isn't required to access resources, only if you want to access user-restricted or internal objects.",
+]
+
+const overlaps = {}
+
+for (const mdxFile of mdxs) {
+  const contents = fs.readFileSync(mdxFile, 'utf-8')
+  if (!contents) continue
+  const md = micromark(contents, { extensions: [mdx()] })
+  const html = parse(md)
+
+  const strings = [...html.getElementsByTagName('p')]
+
+  for (const ele of strings) {
+    const str = ele.innerText
+    const whitelisted = whitelist.find((e) => str.includes(e))
+    if (whitelisted) continue
+    if (overlaps[str])
+      throw `Overlap detected between ${mdxFile} and ${overlaps[str]}: ${str}`
+    overlaps[str] = mdxFile
+  }
+}
+
+console.log('All checks passed!')

package.json

@@ -2,6 +2,7 @@
   "name": "tailwind-plus-protocol",
   "version": "0.1.0",
   "private": true,
+  "type": "module",
   "scripts": {
     "dev": "next dev",
     "build": "next build",
@@ -51,6 +52,9 @@
     "@types/react-dom": "^19",
     "eslint": "^9.32.0",
     "eslint-config-next": "^15",
+    "micromark": "^4.0.2",
+    "micromark-extension-mdx": "^2.1.0",
+    "node-html-parser": "^7.0.1",
     "prettier": "^3.6.2",
     "prettier-plugin-tailwindcss": "^0.6.14",
     "sharp": "0.34.3"

pnpm-lock.yaml

@@ -180,7 +180,7 @@ Game metadata is provided by a series of backend 'metadata providers'. Drop unif
 <Row>
   <Col>
 
-    This endpoint searches all metadata providers for a query.
+    This endpoint imports a game, optionally with metadata.
 
 
     ### Request parameters
@@ -338,10 +338,10 @@ Versions, in Drop, require a lot of metadata to be imported correctly, due to th
 
     <Properties>
       <Property name="id" type="string">
-        The game ID of the unimported version.
+        The game ID of the unimported version to fetch preload information for.
       </Property>
       <Property name="version" type="string">
-        The version name of the unimported version.
+        The version name of the unimported version to fetch preload information for. The version name is the name of the folder or .zip file on disk.
       </Property>
     </Properties>
 
@@ -414,13 +414,13 @@ Versions, in Drop, require a lot of metadata to be imported correctly, due to th
 
     <Properties>
       <Property name="id" type="string">
-        The game ID of the unimported version.
+        The game ID of the unimported version, to import.
       </Property>
       <Property name="version" type="string">
-        The version name of the unimported version.
+        The version name of the unimported version, to import. See above comment (preload) about what it is.
       </Property>
       <Property name="platform" type="string">
-        The platform this version is for. Must be, currently, either "Windows", "Linux", or "macOS". You can mess up the capitalisation.
+        The platform this version is for. Must be, currently, either "Windows", "Linux", or "macOS". The value is technically capitalisation insensitive, but use proper capitalisation where possible.
       </Property>
       <Property name="delta" type="boolean">
         Whether or not this version is a 'delta' version. Read more about delta versions on the main docs: [Version deltas & ordering](https://docs.droposs.org/docs/library#version-deltas--ordering)
@@ -514,10 +514,10 @@ Versions, in Drop, require a lot of metadata to be imported correctly, due to th
         The version name of the unimported version.
       </Property>
       <Property name="platform" type="string">
-        The platform this version is for. Must be, currently, either "Windows", "Linux", or "macOS". You can mess up the capitalisation.
+        The platform this version is for. Must be, currently, either "Windows", "Linux", or "macOS". Capitalisation is technically insensitive, but use proper capitalisation where possible.
       </Property>
       <Property name="delta" type="boolean">
-        Whether or not this version is a 'delta' version. Read more about delta versions on the main docs: [Version deltas & ordering](https://docs.droposs.org/docs/library#version-deltas--ordering)
+        Whether or not this version is a 'delta' version. See above note on how delta versions work.
       </Property>
       <Property name="onlySetup" type="boolean">
         Set as `true` for this example.
@@ -532,15 +532,15 @@ Versions, in Drop, require a lot of metadata to be imported correctly, due to th
         A command to set up the game. Users will be able to run it multiple times, the installer should repair the installation.
       </Property>
       <Property name="setupArgs" type="string">
-        Optional, additional arguments to pass to the setup executable.
+        Optional, additional arguments to pass to the setup executable. Likely more important for setup-only versions.
       </Property>
       <Property name="umuId" type="string">
-        Optional, override the UMU ID for this game. Read more on the [UMU database](https://github.com/Open-Wine-Components/umu-database).
+        Optional, override the UMU ID for this game. See above for documentation on UMU IDs.
       </Property>
     </Properties>
 
     ### Response
-    For the response and how to use task IDs, see [Tasks](/web/tasks). You need the `import:version:read` ACL to connect.
+    See above on the returned task ID and required ACL.
 
   </Col>
   <Col sticky>