From d5d6bde1c60f28d8f032d85eb8fae5ce61d0dcf6 Mon Sep 17 00:00:00 2001 From: Alec LaLonde Date: Sat, 1 Apr 2023 20:14:09 -0600 Subject: [PATCH] Updated outbound docs links --- README.md | 2 +- docs/activities/overview.md | 2 +- docs/activities/permissions.md | 2 +- docs/authentication/overview.md | 2 +- docs/chat/channels.md | 2 +- docs/chat/direct.md | 4 ++-- docs/chat/overview.md | 4 ++-- docs/chat/permissions.md | 2 +- docs/getting-started.md | 2 +- docs/logging/client.md | 2 +- docs/models/data/real-time-array.md | 4 ++-- docs/offline/overview.md | 4 ++-- mkdocs.yml | 2 +- overrides/partials/footer.html | 6 +----- 14 files changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index dc38c34..4bd0117 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Build Master](https://github.com/convergencelabs/js-dev-guide/actions/workflows/build-master.yml/badge.svg)](https://github.com/convergencelabs/js-dev-guide/actions/workflows/build-master.yml) [![Build Develop](https://github.com/convergencelabs/js-dev-guide/actions/workflows/build-develop.yml/badge.svg)](https://github.com/convergencelabs/js-dev-guide/actions/workflows/build-develop.yml) -This repository contains the Convergence JavaScript Developers Guide that is hosted at https://docs.convergence.io/guide/. It was developed using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). +This repository contains the Convergence JavaScript Developers Guide that is hosted at https://guide.convergence.io/. It was developed using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). ## Contributing If you find errors or see room for improvement please create an issue here. Pull requests are always welcome. diff --git a/docs/activities/overview.md b/docs/activities/overview.md index 71e190d..665c4ba 100644 --- a/docs/activities/overview.md +++ b/docs/activities/overview.md @@ -75,4 +75,4 @@ An `Activity` object emits several events that communicate what is happening in | `deleted` | Emitted when an activity that is joined is deleted | | `force_leave` | Emitted when the server forcefully makes the local session leave the activity | -Additional details on these events can be found in subsequent sections, as well as in the [API Documentation](https://docs.convergence.io/js-api/modules/activities.html). +Additional details on these events can be found in subsequent sections, as well as in the [API Documentation](https://api-docs.convergence.io/modules/activities.html). diff --git a/docs/activities/permissions.md b/docs/activities/permissions.md index 6e2aad3..9c8c4c4 100644 --- a/docs/activities/permissions.md +++ b/docs/activities/permissions.md @@ -47,7 +47,7 @@ permissionsManager .then(() => console.log("permissions set")); ``` -Please refer to the [API documentation](https://docs.convergence.io/js-api/modules/activities.html) for available permissions operations. +Please refer to the [API documentation](https://api-docs.convergence.io/modules/activities.html) for available permissions operations. ## Removing Permissions for Joined User It is possible that when permissions are changed that a user that is currently a participant within an activity no longer has sufficient privileges to remained joined. In this case, all sessions for users in that situation will be removed from the Activity. Clients who are removed will receive a `force_leave` event with a message letting them know why they were removed. diff --git a/docs/authentication/overview.md b/docs/authentication/overview.md index 7f5b8a3..13d6d22 100644 --- a/docs/authentication/overview.md +++ b/docs/authentication/overview.md @@ -46,7 +46,7 @@ Convergence.connectWithJwt(domainUrl, jwtClaims).then((domain) => { ``` ## Reconnect Tokens -Sometimes it can be desired to "resume" a prior authenticated connection with Convergence. Thus, after a non-anonymous succesful authentication, a [reconnect token](https://docs.convergence.io/js-api/classes/users_and_identity.convergencesession.html#reconnecttoken) is available on the resulting `ConvergenceSession`. This token can be passed to [Convergence.reconnect](https://docs.convergence.io/js-api/classes/convergence.html#reconnect) to authenticate as the same user for which the token was originally created: +Sometimes it can be desired to "resume" a prior authenticated connection with Convergence. Thus, after a non-anonymous succesful authentication, a [reconnect token](https://api-docs.convergence.io/classes/users_and_identity.convergencesession.html#reconnecttoken) is available on the resulting `ConvergenceSession`. This token can be passed to [Convergence.reconnect](https://api-docs.convergence.io/classes/convergence.html#reconnect) to authenticate as the same user for which the token was originally created: ```js const reconnectToken = window.sessionStorage.getItem('convergence-reconnect-token'); diff --git a/docs/chat/channels.md b/docs/chat/channels.md index fc85288..b522d2f 100644 --- a/docs/chat/channels.md +++ b/docs/chat/channels.md @@ -1,6 +1,6 @@ # Chat Channels -Chat channels are similar to chat rooms in that there are a variable number of participants. The main difference is that channels can be either `public` or `private`, and members are considered part of a [ChatChannel](https://docs.convergence.io/js-api/classes/chat.chatchannel.html) even if they're not currently connected to the channel. +Chat channels are similar to chat rooms in that there are a variable number of participants. The main difference is that channels can be either `public` or `private`, and members are considered part of a [ChatChannel](https://api-docs.convergence.io/classes/chat.chatchannel.html) even if they're not currently connected to the channel. Note that a particular user can only join once, after which subsequent joins will result in an error. An already joined user can subsequently load a `ChatChannel` using `ChatService.get(chatId)`. diff --git a/docs/chat/direct.md b/docs/chat/direct.md index 3da4c0f..f2d0c12 100644 --- a/docs/chat/direct.md +++ b/docs/chat/direct.md @@ -1,10 +1,10 @@ # Direct Chat -Direct chats are between a fixed set of users that are specified on creation. Members cannot be added or removed. For this reason, an immutable additional `otherUsers` property is available on the [DirectChat](https://docs.convergence.io/js-api/classes/chat.directchat.html) instance. +Direct chats are between a fixed set of users that are specified on creation. Members cannot be added or removed. For this reason, an immutable additional `otherUsers` property is available on the [DirectChat](https://api-docs.convergence.io/classes/chat.directchat.html) instance. Unlike channels or rooms, direct chats do not have any metadata like a `name` or `topic`. -Note that you cannot "leave" a direct chat. Once created, the communication line between members is open, until the chat is explictly `removed` via the [ChatService](https://docs.convergence.io/js-api/classes/chat.chatservice.html). +Note that you cannot "leave" a direct chat. Once created, the communication line between members is open, until the chat is explictly `removed` via the [ChatService](https://api-docs.convergence.io/classes/chat.chatservice.html). Direct chats have a similar analogue in Slack's "direct messages". diff --git a/docs/chat/overview.md b/docs/chat/overview.md index 4b9efe5..809d4f6 100644 --- a/docs/chat/overview.md +++ b/docs/chat/overview.md @@ -1,6 +1,6 @@ # Chat Overview -The Chat API allows users to communicate via text embedded directly within the application. The main entry point to the Chat API is the [ChatService](https://docs.convergence.io/js-api/classes/chat.chatservice.html). The `ChatService` can be obtained from the domain using the `chat()` method. +The Chat API allows users to communicate via text embedded directly within the application. The main entry point to the Chat API is the [ChatService](https://api-docs.convergence.io/classes/chat.chatservice.html). The `ChatService` can be obtained from the domain using the `chat()` method. ```js const chatService = domain.chat(); @@ -23,7 +23,7 @@ Convergence provides a few different constructs depending on the particular type ## Chat Info -Users may wish to obtain [information](https://docs.convergence.io/js-api/interfaces/chat.ichatinfo.html) about the particular chat, such as the current members or the timestamp of the most recent event. This information can be obtained from the room via several methods. +Users may wish to obtain [information](https://api-docs.convergence.io/interfaces/chat.ichatinfo.html) about the particular chat, such as the current members or the timestamp of the most recent event. This information can be obtained from the room via several methods. ```js chatService.join('myRoomID').then(room => { diff --git a/docs/chat/permissions.md b/docs/chat/permissions.md index 3c5677e..a96defa 100644 --- a/docs/chat/permissions.md +++ b/docs/chat/permissions.md @@ -2,7 +2,7 @@ Permissions for specific chat rooms can be set at a few different levels: For anybody ("world"), a group of users, or a specific user. More-specific permissions will override less-specific ones, so a user's explicit permission would override the group's permission which the user is in, which would itself override any world permission for a `Chat`. -The [ChatPermissionsManager](https://docs.convergence.io/js-api/classes/chat.chatpermissionmanager.html) provides a variety of functions to get or set permissions for a specific user, group, or globally ("world"). +The [ChatPermissionsManager](https://api-docs.convergence.io/classes/chat.chatpermissionmanager.html) provides a variety of functions to get or set permissions for a specific user, group, or globally ("world"). By default, a room's creator is assigned all permissions. diff --git a/docs/getting-started.md b/docs/getting-started.md index f47c403..99a235c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -33,7 +33,7 @@ Convergence.connect(domainUrl, "Bruce Wayne", "1AmBatman!", { }); ``` -[See here](https://docs.convergence.io/js-api/interfaces/connection_and_authentication.iconvergenceoptions.html) for details about the connection options we support. +[See here](https://api-docs.convergence.io/interfaces/connection_and_authentication.iconvergenceoptions.html) for details about the connection options we support. ## Connecting The first step after setup is to connect to your domain. The simplest way to connect is using a username and password for a domain user. The connect method returns a promise that will either complete with the connected domain, or will be rejected with an error detailing why the connection was not successful. diff --git a/docs/logging/client.md b/docs/logging/client.md index 2ebdf94..1c8962d 100644 --- a/docs/logging/client.md +++ b/docs/logging/client.md @@ -1,5 +1,5 @@ # Client Logging -The Convergence JavaScript client has a built-in logging framework that allows for detailed logging of the client operation. The logging framework facilitates status, error, and debug logging. The [API Documentation](https://docs.convergence.io/js-api/classes/convergence.html#configurelogging) contains specific information on the available options. Logs are output to the JavaScript console. +The Convergence JavaScript client has a built-in logging framework that allows for detailed logging of the client operation. The logging framework facilitates status, error, and debug logging. The [API Documentation](https://api-docs.convergence.io/classes/convergence.html#configurelogging) contains specific information on the available options. Logs are output to the JavaScript console. ## Loggers Log messages within the client are output to specific loggers. The loggers categorize related messages into groups that can be turned on and off independently. diff --git a/docs/models/data/real-time-array.md b/docs/models/data/real-time-array.md index ba19b8f..d1e89c9 100644 --- a/docs/models/data/real-time-array.md +++ b/docs/models/data/real-time-array.md @@ -58,7 +58,7 @@ realTimeArray.reorder(2, 5); ## Other Methods -See the [API documentation](https://docs.convergence.io/js-api/classes/real_time_data.realtimearray.html) for full details of the methods of the `RealTimeArray`. +See the [API documentation](https://api-docs.convergence.io/classes/real_time_data.realtimearray.html) for full details of the methods of the `RealTimeArray`. | Method | Description | | --- | --- | @@ -76,7 +76,7 @@ See the [API documentation](https://docs.convergence.io/js-api/classes/real_time ## Events -See the [API documentation](https://docs.convergence.io/js-api/interfaces/real_time_data.realtimearrayevents.html) for full details of the `RealTimeArray` events. +See the [API documentation](https://api-docs.convergence.io/interfaces/real_time_data.realtimearrayevents.html) for full details of the `RealTimeArray` events. | Event | Description | | --- | --- | diff --git a/docs/offline/overview.md b/docs/offline/overview.md index 909684c..361d2ec 100644 --- a/docs/offline/overview.md +++ b/docs/offline/overview.md @@ -7,7 +7,7 @@ Convergence is first and foremost a realtime collaboration system meant to be co At the moment the primary focus of the offline support is the Real Time Data subsystem. Features: * Changes to models will be stored offline until they have been acknowledged by the server. -* The user can [subscribe](https://docs.convergence.io/js-api/classes/real_time_data.modelservice.html#subscribeoffline) to models to have them proactively downloaded to the local client to ensure they are available in case the user goes offline. +* The user can [subscribe](https://api-docs.convergence.io/classes/real_time_data.modelservice.html#subscribeoffline) to models to have them proactively downloaded to the local client to ensure they are available in case the user goes offline. * Models can be created, modified, and deleted offline. * The client will push changes made offline up to the server when connectivity is restored. @@ -16,7 +16,7 @@ At the moment the primary focus of the offline support is the Real Time Data sub Convergence has a persistence abstraction layer that allows the user to configure how offline data is stored. At the moment Convergence only provides a single Storage Adapter that uses [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) to store offline data. # Configuration and Initialization -To configure Convergence for offline support you need to provide a storage adapter in the [options](https://docs.convergence.io/js-api/interfaces/connection_and_authentication.iconvergenceoptions.html) passed to the ConvergenceDomain. +To configure Convergence for offline support you need to provide a storage adapter in the [options](https://api-docs.convergence.io/interfaces/connection_and_authentication.iconvergenceoptions.html) passed to the ConvergenceDomain. ```typescript const URL = "https://myhost/namespace/domain"; diff --git a/mkdocs.yml b/mkdocs.yml index 1eb15a4..837d465 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ # Basic Info site_name: Convergence Developer Guide -site_url: https://docs.convergence.io/guide/ +site_url: https://guide.convergence.io/ site_author: Convergence Labs, Inc. site_description: >- The developer guide for the Convergence realtime collaboration diff --git a/overrides/partials/footer.html b/overrides/partials/footer.html index 192333f..7630bb4 100644 --- a/overrides/partials/footer.html +++ b/overrides/partials/footer.html @@ -53,12 +53,8 @@ - - {% include "partials/social.html" %} \ No newline at end of file