From 82bf3f9ff5df8366418b7e86ffdc1b7422677141 Mon Sep 17 00:00:00 2001 From: bitfl0wer Date: Sat, 20 May 2023 13:09:22 +0200 Subject: [PATCH 1/3] Add mention of dev client, fix typo --- docs/setup/clients/index.md | 48 +++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index 71ab112..d15cbf1 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -8,32 +8,38 @@ The official {{ project.name }} client is currently being developed at [this rep ## Official host -We currently host the client at [https://app.{{ project.domain }}](https://app.{{ project.domain }}). -You can use it to connect to our official instance by default, -or you can use it to connect to your own by editing your local storage to include the `routeSettings` key with the below example content: +The new, React-only client is being hosted at [https://dev.app.{{ project.domain }}](https://dev.app.{{ project.domain }}). +An older, React Native version of the client can be found at +[https://app.{{ project.domain }}](https://app.{{ project.domain }}). +You can use it to connect to our official instance by default, or you can use it to connect to your +own instance by editing your local storage to include the `routeSettings` key with the below example +content: ```json { - "api": "https://staging.{{ project.domain }}/api/v9", - "cdn": "https://cdn.staging.{{ project.domain }}", - "gateway": "wss://gateway.staging.{{ project.domain }}", - "invite": "https://staging.{{ project.domain }}/invite", - "template": "https://staging.{{ project.domain }}/template", - "gift": "https://staging.{{ project.domain }}/gift", - "scheduledEvent": "https://staging.{{ project.domain }}/events" + "api": "https://staging.{{ project.domain }}/api/v9", + "cdn": "https://cdn.staging.{{ project.domain }}", + "gateway": "wss://gateway.staging.{{ project.domain }}", + "invite": "https://staging.{{ project.domain }}/invite", + "template": "https://staging.{{ project.domain }}/template", + "gift": "https://staging.{{ project.domain }}/gift", + "scheduledEvent": "https://staging.{{ project.domain }}/events" } ``` Replace the above endpoints with your own. If your domain name is `https://whatever.notasite`, then you'll most likely want to enter -`https://whatever.noasite/api/v9` for the API endpoint, etc. +`https://whatever.notasite/api/v9` for the API endpoint, etc. + +If you're using the React Native client, you can also edit these settings by visiting [https://app.{{ project.domain }}/settings](https://app.{{ project.domain }}/settings). ## Setup/Building +These Instructions refer to the old, React Native client, and therefore do not apply to the new, React-only client. ### Dependencies -- [Git](https://git-scm.com/) -- [NodeJS](https://nodejs.org). Version 16+ -- [yarn](https://yarnpkg.com/) (preferred) or npm +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org). Version 16+ +- [yarn](https://yarnpkg.com/) (preferred) or npm In your terminal: @@ -86,13 +92,13 @@ Files will be built to `web-build` To contribute: -- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) -- Run the building instructions. -- Commit & Push. -- Pull Request & Done! +- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) +- Run the building instructions. +- Commit & Push. +- Pull Request & Done! ### What can I contribute? -- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. -- Implementing other things like voice/video is fine too, though -- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. +- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. +- Implementing other things like voice/video is fine too, though +- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. From e704f868d89848d42113bef3ad9134a0a14db94a Mon Sep 17 00:00:00 2001 From: bitfl0wer Date: Sat, 20 May 2023 13:10:55 +0200 Subject: [PATCH 2/3] Run prettier --- docs/assets/js/missingroutes.js | 9 +++++++-- docs/contributing/instances.md | 2 +- docs/setup/clients/index.md | 35 +++++++++++++++++---------------- docs/setup/server/index.md | 2 +- docs/setup/server/wellknown.md | 3 ++- 5 files changed, 29 insertions(+), 22 deletions(-) diff --git a/docs/assets/js/missingroutes.js b/docs/assets/js/missingroutes.js index 9b48ebe..fb94b1e 100644 --- a/docs/assets/js/missingroutes.js +++ b/docs/assets/js/missingroutes.js @@ -19,8 +19,13 @@ document const json = await res.json(); const missingRoutes = json.routes; - document.getElementById("counter").innerHTML = `We implement ${json.discord - json.missing}/${json.discord} endpoints from Discord.com ` + - `as well as ${(json.spacebar + json.missing) - json.discord} additional endpoints.`; + document.getElementById("counter").innerHTML = + `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"); diff --git a/docs/contributing/instances.md b/docs/contributing/instances.md index 18d451a..3f9dd18 100644 --- a/docs/contributing/instances.md +++ b/docs/contributing/instances.md @@ -22,4 +22,4 @@ We recommend (not required) that you: - 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. \ No newline at end of file + If doing so, use this domain as the `url` field in your community instances PR. diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index d15cbf1..5e79c70 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -17,13 +17,13 @@ content: ```json { - "api": "https://staging.{{ project.domain }}/api/v9", - "cdn": "https://cdn.staging.{{ project.domain }}", - "gateway": "wss://gateway.staging.{{ project.domain }}", - "invite": "https://staging.{{ project.domain }}/invite", - "template": "https://staging.{{ project.domain }}/template", - "gift": "https://staging.{{ project.domain }}/gift", - "scheduledEvent": "https://staging.{{ project.domain }}/events" + "api": "https://staging.{{ project.domain }}/api/v9", + "cdn": "https://cdn.staging.{{ project.domain }}", + "gateway": "wss://gateway.staging.{{ project.domain }}", + "invite": "https://staging.{{ project.domain }}/invite", + "template": "https://staging.{{ project.domain }}/template", + "gift": "https://staging.{{ project.domain }}/gift", + "scheduledEvent": "https://staging.{{ project.domain }}/events" } ``` @@ -35,11 +35,12 @@ If you're using the React Native client, you can also edit these settings by vis ## Setup/Building These Instructions refer to the old, React Native client, and therefore do not apply to the new, React-only client. + ### Dependencies -- [Git](https://git-scm.com/) -- [NodeJS](https://nodejs.org). Version 16+ -- [yarn](https://yarnpkg.com/) (preferred) or npm +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org). Version 16+ +- [yarn](https://yarnpkg.com/) (preferred) or npm In your terminal: @@ -92,13 +93,13 @@ Files will be built to `web-build` To contribute: -- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) -- Run the building instructions. -- Commit & Push. -- Pull Request & Done! +- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) +- Run the building instructions. +- Commit & Push. +- Pull Request & Done! ### What can I contribute? -- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. -- Implementing other things like voice/video is fine too, though -- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. +- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. +- Implementing other things like voice/video is fine too, though +- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. diff --git a/docs/setup/server/index.md b/docs/setup/server/index.md index 65f2ff0..44a9019 100644 --- a/docs/setup/server/index.md +++ b/docs/setup/server/index.md @@ -14,7 +14,7 @@ We do not recommend using Windows to run {{ project.name }}. ## Dependencies - [Git](https://git-scm.com/) -- [NodeJS](https://nodejs.org). Version 16+ (for `npm`, `node` commands) +- [NodeJS](https://nodejs.org). Version 16+ (for `npm`, `node` commands) - [Python](https://www.python.org/). Version 3+. Make sure this is executable via `python` in your terminal. (See: `python-is-python3` package) - On Linux: `gcc`/`g++`. Packaged with `build-essential` on Debian/Ubuntu and `base-devel` on Arch. diff --git a/docs/setup/server/wellknown.md b/docs/setup/server/wellknown.md index 8342fdf..36b8f16 100644 --- a/docs/setup/server/wellknown.md +++ b/docs/setup/server/wellknown.md @@ -6,8 +6,9 @@ Users can enter a domain, e.g. `spacebar.chat` as shorthand, and their client wi and from there the Gateway and CDN endpoints. Example `/.well-known/spacebar` file: + ```json { "api": "https://api.spacebar.chat/api/v9" } -``` \ No newline at end of file +``` From ebe6d2d22939969973ce21add0058b805a4da76a Mon Sep 17 00:00:00 2001 From: Stilic Date: Wed, 14 Jun 2023 14:02:20 +0200 Subject: [PATCH 3/3] Fix typo in config page --- docs/setup/server/configuration/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup/server/configuration/index.md b/docs/setup/server/configuration/index.md index db611ca..fecd737 100644 --- a/docs/setup/server/configuration/index.md +++ b/docs/setup/server/configuration/index.md @@ -88,7 +88,7 @@ Arrays are represented by \_[number] in a config key. For example, multiple `gui | security_twoFactor_generateBackupCodes | true | boolean | Whether to generate backup codes for MFA users | | security_requestSignature | Secret secret | string | The signature required for CDN or [Imagor](imagor.md) usage | | security_jwtSecret | Secure secret | string | The secret used for user token generation | -| [security_forwadedFor](../reverseProxy.md) | null | string | HTTP header for user's real IP. | +| [security_forwardedFor](../reverseProxy.md) | null | string | HTTP header for user's real IP. | | security_ipdataApiKey | {{ project.name }} IPdata key | string | API key used for IP geolocation and proxy detection | | security_mfaBackupCodeCount | 10 | number | Number of MFA backup codes to generate | | security_statsWorldReadable | true | boolean | Whether instance stats are publically accessible or require right |