rebase with master, remove space from directory name

.github/FUNDING.yml

@@ -1 +1 @@
-open_collective: fosscord
+open_collective: spacebar

.github/workflows/build.yml

@@ -1,5 +1,6 @@
 name: Build to GitHub Pages
 on:
+    workflow_dispatch:
     push:
         branches:
             - master
@@ -12,9 +13,10 @@ jobs:
             - uses: actions/setup-python@v2
               with:
                   python-version: 3.x
-            - run: python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index
+            - run: curl https://raw.githubusercontent.com/spacebarchat/spacebarchat/master/CODE_OF_CONDUCT.md -o docs/contributing/conduct.md
+            - run: python3 -m pip install -r requirements.txt
             - run: mkdocs build
-            - run: echo docs.fosscord.com >> site/CNAME
+            - run: echo docs.spacebar.chat >> site/CNAME
             - name: Deploy 🚀
               uses: JamesIves/github-pages-deploy-action@4.1.3
               with:

.gitignore

@@ -1,2 +1,3 @@
 site/
 .DS_STORE
+venv/

.vscode/settings.json

@@ -1,9 +1,3 @@
 {
-	"cSpell.words": [
-		"Fosscord",
-		"landingpage",
-		"Middlewares",
-		"Roadmap",
-		"screenshare"
-	]
+	"cSpell.words": ["landingpage", "Middlewares", "Roadmap", "screenshare"]
 }

README.md

@@ -1,35 +1,37 @@
-# Fosscord Docs
+# Spacebar Docs
 
-[![Build to GitHub Pages](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml/badge.svg)](https://github.com/fosscord/fosscord-docs/actions/workflows/build.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Build to GitHub Pages](https://github.com/spacebarchat/docs/actions/workflows/build.yml/badge.svg)](https://github.com/spacebarchat/docs/actions/workflows/build.yml)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/86622c9d-4952-4da5-9825-cc016e4a5e5f/deploy-status)](https://app.netlify.com/sites/spacebar-chat/deploys)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/fosscord/fosscord-docs)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/spacebarchat/docs)
 
-## How to get started:
+## How to get started
 
 1. Fork this repository.
 2. Clone the forked repository.
 
     ```bash
-    git clone https://github.com/<YOUR_USERNAME_HERE>/fosscord-docs
+    git clone https://github.com/<YOUR_USERNAME_HERE>/docs
     ```
 
 3. Install dependencies.
 
     ```bash
-    python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index
+    python3 -m pip install -r requirements.txt
     ```
 
 4. Edit documents(s).
 
     - Format document(s).
 
-    fosscord uses [prettier](https://prettier.io) formatter to consistently format our documents. Instructions to install and use prettier can be found [here](https://prettier.io/docs/en/install.html).
+    Spacebar uses [prettier](https://prettier.io) formatter to consistently format our documents. Instructions to install and use prettier can be found [here](https://prettier.io/docs/en/install.html).
 
     If you are using vscode, install the [prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to automatically format documents on save.
 
 5. Test locally.
 
-    - Serve in http://127.0.0.1:8000 with hot reload:
+    - Serve in <http://127.0.0.1:8000> with hot reload:
 
         ```bash
         python3 -m mkdocs serve

docs/assets/extra.css

@@ -9,3 +9,18 @@
 .md-grid {
 	max-width: 65rem;
 }
+
+.md-typeset .fc-search .md-input {
+	background: var(--md-default-bg-color);
+}
+
+[data-md-color-scheme="slate"] .md-typeset .fc-search .md-input {
+	background: var(--md-code-bg-color);
+}
+
+#rights-container {
+	font-size: 0.75rem;
+	display: grid;
+	grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
+	margin-bottom: 15px;
+}

docs/assets/js/missingroutes.js

@@ -0,0 +1,38 @@
+const MISSING_ROUTES_LIST =
+	"https://raw.githubusercontent.com/spacebarchat/missing-routes/main/missing.json";
+const listMount = document.getElementById("missing-routes-list");
+
+document
+	.getElementById("missing-routes-search")
+	.addEventListener("input", (e) => {
+		const content = e.target.value.toLowerCase();
+
+		for (let elem of listMount.children) {
+			if (elem.innerText.toLowerCase().indexOf(content) !== -1)
+				elem.style.display = "list-item";
+			else elem.style.display = "none";
+		}
+	});
+
+(async () => {
+	const res = await fetch(MISSING_ROUTES_LIST);
+	const json = await res.json();
+	const missingRoutes = json.routes;
+
+	document.getElementById("counter").textContent =
+		`We implement ${json.discord - json.missing}/${
+			json.discord
+		} endpoints from Discord.com ` +
+		`as well as ${
+			json.spacebar + json.missing - json.discord
+		} additional endpoints.`;
+
+	for (let route of missingRoutes) {
+		const elem = document.createElement("li");
+		const inner = document.createElement("code");
+		inner.innerText = route;
+		elem.appendChild(inner);
+
+		listMount.appendChild(elem);
+	}
+})();

docs/assets/js/rightsCalculator.js

@@ -6,15 +6,30 @@
 		// grab the table data elements
 		[...document.querySelectorAll("td")]
 			.map((x) => x.innerText) // get their content
-			.map((x, i) =>
-				x.indexOf("<<") == 2 // if this column is the `value` column
-					? x.split(" ").reverse()[0] // get the value we shift by
-					: x,
-			); // otherwise dont do anything
+			.map(
+				(x, i) =>
+					x.indexOf("<<") == 2 // if this column is the `value` column
+						? x.split(" ").reverse()[0] // get the value we shift by
+						: x, // otherwise dont do anything
+			);
+
 	const mount = document.getElementById("rights-container");
 	const outputMount = document.getElementById("rights-output");
 	var calculated = 0n;
 
+	const calcBitsFromInput = () => {
+		const value = BigInt(outputMount.value);
+		calculated = value;
+
+		for (const div of mount.children) {
+			const toggle = div.children[0];
+			const flag = BigInt(toggle.getAttribute("id"));
+			toggle.checked = ((value >> flag) & 1n) != 0n;
+		}
+	};
+
+	outputMount.addEventListener("input", calcBitsFromInput);
+
 	for (var i = 0; i < rights.length; i += NUM_COLUMNS) {
 		const name = rights[i];
 		const shift = rights[i + 1];
@@ -25,7 +40,7 @@
 		input.setAttribute("type", "checkbox");
 		input.setAttribute("id", shift);
 		const label = document.createElement("label");
-		label.setAttribute("for", label.id);
+		label.setAttribute("for", input.id);
 		label.innerText = name.toUpperCase();
 
 		div.appendChild(input);
@@ -44,13 +59,14 @@
 					}
 					event.target.removeAttribute("disabled");
 
-					outputMount.innerText = "1";
+					calculated++;
+					outputMount.value = "1";
 					return;
 				} else {
 					for (var elem of mount.children) {
 						elem.children[0].removeAttribute("disabled");
 					}
-					outputMount.innerText = calculated;
+					outputMount.value = --calculated;
 					return;
 				}
 			}
@@ -59,7 +75,10 @@
 				? calculated + value
 				: calculated - value;
 
-			outputMount.innerText = calculated;
+			outputMount.value = calculated;
 		});
 	}
+
+	// if you reload the page, your input is still present.
+	calcBitsFromInput();
 })();

docs/assets/overrides/routes.html

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+
+<head>
+	<meta charset="utf-8">
+	<script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+</head>
+
+<body>
+	<rapi-doc
+		spec-url = "https://raw.githubusercontent.com/spacebarchat/server/master/assets/openapi.json"
+		theme="dark"
+		sort-endpoints-by="none"
+		header-color="#4051b5"
+		primary-color="#4051b5"
+		render-style="focused"
+		schema-expand-level=1
+		schema-style="table"
+		default-schema-tab="schema"
+		show-components="true"
+		heading-text="Spacebar HTTP API Documentation"
+		show-curl-before-try="true"
+		allow-spec-url-load="false"
+		allow-spec-file-load="false"
+	>
+		<a slot="logo" href="https://docs.spacebar.chat" style="margin-left: 20px; width: 30px; height: 30px;">
+			<img style="width: 30px; height: 30px;" src="https://docs.spacebar.chat/assets/logo.svg" />
+		</a>
+</body>
+
+</html>

docs/contributing/index.md

@@ -4,7 +4,7 @@
 
 ## Style and a note on etiquette
 
--   We use [prettier](https://www.npmjs.com/package/prettier) for code formatting. We have a `.prettierrc` file in fosscord-server's root
+-   We use [prettier](https://www.npmjs.com/package/prettier) for code formatting. We have a `.prettierrc` file in {{ project.name.lower() }}-server's root
     and use a git precommit hook to autorun it.
 -   Try to stay consistent with the rest of the project
 -   Try to keep each commit to a single feature or idea, with descriptions of what it is and why it is done. No "Large refactor" commits that touch every file,
@@ -16,7 +16,7 @@
 
 ## Structure
 
-Fosscord is written in Typescript and is comprised of 4 main parts:
+{{ project.name }} is written in TypeScript and is comprised of 4 main parts:
 
 -   REST HTTP API server
 -   Websocket Gateway server for realtime communication with clients
@@ -29,7 +29,7 @@ Generally, the approach is to just see what the Discord.com client sends and rec
 and guessing about any functionality server-side, if it's undocumented.
 
 For a lot of things it's pretty simple to guess, `GET /api/users/@me` returns private details about your user for example.
-This route is also detailed in [Discords own documentation](https://discord.com/developers/), [here specifically](https://discord.com/developers/docs/resources/user#get-current-user).
+This route is also detailed in [Discords own documentation](https://discord.com/developers/docs/intro), [here specifically](https://discord.com/developers/docs/resources/user#get-current-user).
 
 Discord generally does not document anything that is not related to application/bot development, though.
 As an example, `GET /api/updates?platform={}` which returns the `url`, `pub_date`, `name` and any `notes` about the latest client release for a platform.
@@ -40,5 +40,5 @@ Easy fix though, just edit the `DeveloperOptionsStore` localStorage key so that
 
 !!! warning
 
-    Make sure you rerun `npm run build` every time you edit source code. Additionally, make sure you run `npm run generate:schema` whenever you change a
-    schema. If you want to do both, there's a shortcut: `npm run setup`.
+    Make sure you rerun `npm run build` every time you edit source code, or just use `npm run watch` to make TypeScript automatically recompile on code changes.
+    Wenn making changes to schemas or HTTP routes, run `npm run generate:schemas` and `npm run generate:openapi` to update the schemas used for validating incoming requests and generating the API documentation.

docs/contributing/instances.md

@@ -0,0 +1,26 @@
+# For Instance Owners
+
+The below are the rules for instance owners who look to be featured in our [community instances](https://github.com/spacebarchat/spacebarchat/tree/master/instances) list.
+If you do not meet these criteria, your instance will simply not be featured on our website.
+
+Your instance:
+
+1. Rules must be in line with our [Code of Conduct](conduct.md).
+2. Must not contain any Discord Inc. branding, such as including "cord" in the name or the Discord logo in promotional material.
+3. Must not host the Discord Inc. client in any capacity.
+4. Must be moderated for _at least_ publically accessible guilds. This includes guilds accessible from Discovery or a 'guild directory' channel in an auto join guild.
+5. Must have at least regular uptime, meaning it is available at a consistent time of day.
+6. Must have a valid and monitored [`general_correspondenceEmail` config](/setup/server/configuration) set.
+7. Must not have default [rights](/setup/server/security/rights) that include operator or other administrative rights.
+8. Use an [image proxy](/setup/server/configuration/imageProxy), e.g. Imagor, as no image proxy allows attackers to learn user IP addresses.
+9. Have a valid SSL/TLS certificate for all endpoints.
+
+We recommend (not required) that you:
+
+-   Enable [Email verification](/setup/server/email), for anti-spam purposes.
+-   Enable [Captcha](/setup/server/security/captcha), for anti-spam purposes.
+-   Run your instance under [SystemD](/setup/server/systemd) or a similar system in your distro, for automatic restarting.
+-   Provide some mechanism for users to report content. This may be as simple as more openly advertising your correspondence email (i.e. outside `GET /api/policies/instance` or `/api/ping`).
+-   Provide some mechanism for instance status, such as [Grafana](https://grafana.com/).
+-   Host a [`/.well-known/spacebar`](/setup/server/wellknown) file on the domain you wish users associate with your instance, e.g. `spacebar.chat`.
+    If doing so, use this domain as the `url` field in your community instances PR.