Skip to content

Commit

Permalink
Updated outbound links to dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alalonde committed Apr 1, 2023
1 parent 3625673 commit 95a06a9
Show file tree
Hide file tree
Showing 33 changed files with 62 additions and 72 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Convergence JavaScript Client
[![Build](https://github.com/convergencelabs/convergence-client-javascript/actions/workflows/build.yml/badge.svg)](https://github.com/convergencelabs/convergence-client-javascript/actions/workflows/build.yml)

This is the first (and only) client for the [Convergence Collaboration Framework](https://convergence.io). It runs in all evergreen browsers and node.js as well (with a [slight configuration](https://docs.convergence.io/guide/getting-started.html)).
This is the first (and only) client for the [Convergence Collaboration Framework](https://convergence.io). It runs in all evergreen browsers and node.js as well (with a [slight configuration](https://guide.convergence.io/getting-started.html)).

The client is implemented in typescript. The build system uses both Rollup and WebPack to bundle and transpile the typescript to single files using a variety of module systems. For testing, the typescript compiler is used to compile the code into ES5 and commonjs modules to support direct unit testing in node.

Expand All @@ -18,7 +18,7 @@ The core Convergence capability is composed of multiple individual projects that
npm install @convergence/convergence
```

See our [developer guide](https://docs.convergence.io/guide/getting-started.html) for a quick overview and some getting started code snippets.
See our [developer guide](https://guide.convergence.io/getting-started.html) for a quick overview and some getting started code snippets.

## Versioning
The Convergence JavaScript Client follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) with two notable exceptions:
Expand All @@ -28,16 +28,6 @@ The Convergence JavaScript Client follows [Semantic Versioning 2.0.0](https://se

These deviations from strict Semantic Versioning are intended to get potential new functionality to the community as fast as possible in order to get rapid feedback before the API is finalized. If you do not want to be an early adopter, then you should refrain from using pre-release versions or API marked as `@experimental`.

## Support

[Convergence Labs](https://convergencelabs.com) provides several different channels for support:

- Please use the [Discourse Forum](https://forum.convergence.io) for general and technical questions, so the whole community can benefit.
- For paid dedicated support, integration assistance, or other custom development services, [contact us](https://convergence.io/contact-sales/) directly.
- Chat with us on the [Convergence Public Slack](https://slack.convergence.io).
- Email <support@convergencelabs.com> for all other inquiries.


## Developing
To build a distribution build:
```
Expand Down
2 changes: 1 addition & 1 deletion src/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The API Docs are organized by module which roughly relate to the main services t
* [Offline](modules/offline.html)

## Getting Started
The example below shows a simple use case: Connecting to a <a href="https://docs.convergence.io/guide/domain/overview.html" class="tsd-external-link">domain</a>, opening a [[RealTimeModel]] from the domain's [[ModelService]], and finally writing out the contents of that model to the console.
The example below shows a simple use case: Connecting to a <a href="https://guide.convergence.io/domain/overview.html" class="tsd-external-link">domain</a>, opening a [[RealTimeModel]] from the domain's [[ModelService]], and finally writing out the contents of that model to the console.

```Typescript
import {Convergence} from "@convergence/convergence";
Expand Down
6 changes: 3 additions & 3 deletions src/main/Convergence.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ import {Logging} from "./util/log/Logging";
* This is the entry point for the Convergence JS client. It allows users to connect
* to the Convergence Engine using a variety of authentication methods. On success,
* each connection method returns a [[ConvergenceDomain]] bound to the
* [Domain](https://docs.convergence.io/guide/domain/overview.html) at the specified URL.
* [Domain](https://guide.convergence.io/domain/overview.html) at the specified URL.
*
* See the [Developer Guide](https://docs.convergence.io/guide/authentication/overview.html)
* See the [Developer Guide](https://guide.convergence.io/authentication/overview.html)
* for more information about authentication options.
*/
export class Convergence {
Expand Down Expand Up @@ -119,7 +119,7 @@ export class Convergence {

/**
* Connects to a Convergence Domain using a JSON Web Token (JWT) for
* authentication. See the [developer guide](https://docs.convergence.io/guide/authentication/json-web-tokens.html)
* authentication. See the [developer guide](https://guide.convergence.io/authentication/json-web-tokens.html)
* for information about configuring the server to accept JWTs.
*
* @param url
Expand Down
20 changes: 10 additions & 10 deletions src/main/ConvergenceDomain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ import IConvergenceMessage = com.convergencelabs.convergence.proto.IConvergenceM
* Convergence. All interactions with the Domain start with this class, through
* several "services" that provide the following functionality:
*
* - [[ModelService]]: Manage [models (data)](https://docs.convergence.io/guide/models/model-service.html)
* - [[IdentityService]]: Manage [users and groups](https://docs.convergence.io/guide/identity/overview.html)
* - [[ActivityService]]: Manage [activities](https://docs.convergence.io/guide/activities/overview.html)
* - [[PresenceService]]: Manage [presence](https://docs.convergence.io/guide/presence/overview.html)
* - [[ChatService]]: Create [chat](https://docs.convergence.io/guide/chat/overview.html)s and send and receive messages
* - [[ModelService]]: Manage [models (data)](https://guide.convergence.io/models/model-service.html)
* - [[IdentityService]]: Manage [users and groups](https://guide.convergence.io/identity/overview.html)
* - [[ActivityService]]: Manage [activities](https://guide.convergence.io/activities/overview.html)
* - [[PresenceService]]: Manage [presence](https://guide.convergence.io/presence/overview.html)
* - [[ChatService]]: Create [chat](https://guide.convergence.io/chat/overview.html)s and send and receive messages
*
* This object itself is the result of a successful connection and authentication
* to a Convergence server via one of the [[Convergence]] connection methods.
Expand Down Expand Up @@ -333,7 +333,7 @@ export class ConvergenceDomain extends ConvergenceEventEmitter<IConvergenceDomai

/**
* Gets the ModelService, which is used for interacting with
* [Real Time Models](https://docs.convergence.io/guide/models/overview.html).
* [Real Time Models](https://guide.convergence.io/models/overview.html).
*
* ```typescript
* const modelService = domain.models();
Expand All @@ -348,7 +348,7 @@ export class ConvergenceDomain extends ConvergenceEventEmitter<IConvergenceDomai

/**
* Gets the IdentityService, which is used for obtaining information about
* [Users](https://docs.convergence.io/guide/identity/overview.html).
* [Users](https://guide.convergence.io/identity/overview.html).
*
* ```typescript
* const identityService = domain.identity();
Expand All @@ -363,7 +363,7 @@ export class ConvergenceDomain extends ConvergenceEventEmitter<IConvergenceDomai

/**
* Gets the ActivityService, which is used for interacting with
* [Activities](https://docs.convergence.io/guide/activities/overview.html).
* [Activities](https://guide.convergence.io/activities/overview.html).
*
* ```typescript
* const activityService = domain.activities();
Expand All @@ -378,7 +378,7 @@ export class ConvergenceDomain extends ConvergenceEventEmitter<IConvergenceDomai

/**
* Gets the PresenceService, which is used to gain insight into the
* [presence](https://docs.convergence.io/guide/presence/overview.html)
* [presence](https://guide.convergence.io/presence/overview.html)
* of Domain Users.
*
* @example
Expand All @@ -396,7 +396,7 @@ export class ConvergenceDomain extends ConvergenceEventEmitter<IConvergenceDomai

/**
* Gets the ChatService, which is used to send and receive
* [chat messages](https://docs.convergence.io/guide/chat/overview.html).
* [chat messages](https://guide.convergence.io/chat/overview.html).
*
* @example
* ```typescript
Expand Down
2 changes: 1 addition & 1 deletion src/main/activity/ActivityService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import {ActivityPermissionUtils} from "./ActivityPermissionUtils";
* Activities in Convergence. Activities provide a mechanism to communicate
* `where` users are operating within a system and `what` they are doing.
*
* See the [developer guide](https://docs.convergence.io/guide/activities/overview.html)
* See the [developer guide](https://guide.convergence.io/activities/overview.html)
* for an introduction to Activities.
*
* @module Activities
Expand Down
2 changes: 1 addition & 1 deletion src/main/chat/ChatService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Object.freeze(Events);
* as textual communication limited to either a fixed set of participants, or a
* [[ChatRoom]] in which any members can send and receive messages.
*
* See the [developer guide](https://docs.convergence.io/guide/chat/overview.html)
* See the [developer guide](https://guide.convergence.io/chat/overview.html)
* for a few chat examples.
*
* @module Chat
Expand Down
2 changes: 1 addition & 1 deletion src/main/chat/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* The Chat API allows users to communicate via text embedded directly within
* the application.
*
* See the [developer guide](https://docs.convergence.io/guide/chat/overview.html)
* See the [developer guide](https://guide.convergence.io/chat/overview.html)
* for a few chat examples.
*
* @moduledefinition Chat
Expand Down
2 changes: 1 addition & 1 deletion src/main/identity/IdentityService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const validSearchFields: UserField[] = ["username", "email", "firstName", "lastN
/**
* Provides a suite of utilities for looking up users and groups in the current domain.
*
* See some common use cases in the [developer guide](https://docs.convergence.io/guide/identity/overview.html).
* See some common use cases in the [developer guide](https://guide.convergence.io/identity/overview.html).
*
* Note that users and groups cannot (yet) be managed through this service. See the
* REST API for domain user and group management.
Expand Down
2 changes: 1 addition & 1 deletion src/main/identity/UserQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {UserField} from "./IdentityService";
* A configuration for a query for [[DomainUser]]s. [[term]] and [[fields]] are
* required.
*
* See the [developer guide](https://docs.convergence.io/guide/identity/overview.html)
* See the [developer guide](https://guide.convergence.io/identity/overview.html)
* for an example.
*
* @module Users and Identity
Expand Down
2 changes: 1 addition & 1 deletion src/main/identity/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* This subsystem provides a suite of utilities for looking up users and groups
* in the current domain.
*
* See some common use cases in the [developer guide](https://docs.convergence.io/guide/identity/overview.html).
* See some common use cases in the [developer guide](https://guide.convergence.io/identity/overview.html).
*
* @moduledefinition Users and Identity
*/
Expand Down
8 changes: 4 additions & 4 deletions src/main/model/ModelService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Object.freeze(ModelServiceEventConstants);

/**
* This is the main entry point in Convergence for working with
* [real time data models](https://docs.convergence.io/guide/models/overview.html).
* [real time data models](https://guide.convergence.io/models/overview.html).
* [[RealTimeModel]]s can be created, opened, deleted, and managed from the [[ModelService]].
*
* See [[IModelServiceEvents]] for the events that may be emitted on this model.
Expand Down Expand Up @@ -402,7 +402,7 @@ export class ModelService extends ConvergenceEventEmitter<IConvergenceEvent> {
}

/**
* Searches for models using the model [query syntax](https://docs.convergence.io/guide/models/queries.html).
* Searches for models using the model [query syntax](https://guide.convergence.io/models/queries.html).
* Only `SELECT`s are currently supported. The grammar is as follows:
*
* ```
Expand Down Expand Up @@ -491,7 +491,7 @@ export class ModelService extends ConvergenceEventEmitter<IConvergenceEvent> {
* be opened. If the model does not exist it will be created first, and then
* opened.
*
* [See here](https://docs.convergence.io/guide/models/model-service.html#note-about-race-conditions)
* [See here](https://guide.convergence.io/models/model-service.html#note-about-race-conditions)
* for more context about race conditions this alleviates.
*
* @param options
Expand Down Expand Up @@ -603,7 +603,7 @@ export class ModelService extends ConvergenceEventEmitter<IConvergenceEvent> {
}

/**
* Opens an existing model, by id, in [history mode](https://docs.convergence.io/guide/models/history.html).
* Opens an existing model, by id, in [history mode](https://guide.convergence.io/models/history.html).
*
* @param id
* The id of the model to open in history mode.
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/Path.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export type PathElement = string | number;
* ```
*
* See the
* [developer guide](https://docs.convergence.io/guide/models/overview.html#paths) for
* [developer guide](https://guide.convergence.io/models/overview.html#paths) for
* more examples of using paths to get parts of a model's contents.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/historical/HistoricalModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Object.freeze(HistoricalModelEventConstants);
* to access the data associated with this model's "current" version. Note that these
* return a read-only [[HistoricalObject]] or [[HistoricalElement]] respectively.
*
* See the [developer guide](https://docs.convergence.io/guide/models/history.html)
* See the [developer guide](https://guide.convergence.io/models/history.html)
* for some examples and additional information.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* developers from the difficulties of implementing Operational Transformation.
* It does this by supporting a strict set of data: JSON.
*
* See our [developer guide](https://docs.convergence.io/guide/models/overview.html)
* See our [developer guide](https://guide.convergence.io/models/overview.html)
* for additional information.
*
* To get started with Real Time Data, get an instance of the [[ModelService]]
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/observable/ObservableElement.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export interface ObservableElementEvents {
readonly MODEL_CHANGED: string;

/**
* Emitted when a remote [reference](https://docs.convergence.io/guide/models/references/references.html)
* Emitted when a remote [reference](https://guide.convergence.io/models/references/references.html)
* is created on this [[RealTimeElement]]. See [[RemoteReferenceCreatedEvent]] for the actual emitted event.
*
* @event
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/reference/ElementReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {DomainUser} from "../../identity";
/**
* Represents one or more elements in a [[RealTimeModel]] that must be adjusted
* while the data is changing. See an example in the
* [developer guide](https://docs.convergence.io/guide/models/references/realtimemodel.html).
* [developer guide](https://guide.convergence.io/models/references/realtimemodel.html).
*
* @module Real Time Data
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/reference/IndexReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {DomainUser} from "../../identity";
/**
* Represents one or more indices in a [[RealTimeString]] that must be adjusted while
* the data is changing. See the
* [developer guide](https://docs.convergence.io/guide/models/references/realtimestring.html)
* [developer guide](https://guide.convergence.io/models/references/realtimestring.html)
* for some examples.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/reference/LocalModelReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface ModelReferenceCallbacks {

/**
* The parent class for a
* [local reference](https://docs.convergence.io/guide/models/references/local-references.html).
* [local reference](https://guide.convergence.io/models/references/local-references.html).
*
* @module Real Time Data
*/
Expand Down
4 changes: 2 additions & 2 deletions src/main/model/reference/ModelReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import {DomainUser} from "../../identity";
import { RealTimeElement, RealTimeModel } from "../rt";

/**
* All the different types of [references](https://docs.convergence.io/guide/models/references/references.html).
* All the different types of [references](https://guide.convergence.io/models/references/references.html).
*
* @module Real Time Data
*/
Expand Down Expand Up @@ -60,7 +60,7 @@ export interface ModelReferenceEvents {
}

/**
* The base class for all [references](https://docs.convergence.io/guide/models/references/references.html),
* The base class for all [references](https://guide.convergence.io/models/references/references.html),
* which are essentially pointers to elements and data within a [[RealTimeModel]].
* They are typically used to implement transient UX constructs such as text selections
* and cursors.
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/reference/PropertyReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {DomainUser} from "../../identity";
/**
* Represents one or more properties in a [[RealTimeObject]] that must be adjusted while
* the data is changing. See the
* [developer guide](https://docs.convergence.io/guide/models/references/realtimeobject.html)
* [developer guide](https://guide.convergence.io/models/references/realtimeobject.html)
* for some examples.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/reference/RangeReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface IndexRange {
/**
* Represents a range of text in a [[RealTimeString]] that must be adjusted while
* the data is changing. See the
* [developer guide](https://docs.convergence.io/guide/models/references/realtimestring.html)
* [developer guide](https://guide.convergence.io/models/references/realtimestring.html)
* for some examples.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/rt/RealTimeArray.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export interface RealTimeArrayEvents extends ObservableArrayEvents {
* See [[RealTimeArrayEvents]] for the events that may be emitted on remote changes
* to this object.
*
* Also see the [developer guide](https://docs.convergence.io/guide/models/data/real-time-array.html)
* Also see the [developer guide](https://guide.convergence.io/models/data/real-time-array.html)
* for more information.
*
* @module Real Time Data
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/rt/RealTimeBoolean.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface RealTimeBooleanEvents extends ObservableBooleanEvents {
* changes to this object.
*
* Common use cases are documented in the
* [developer guide](https://docs.convergence.io/guide/models/data/real-time-boolean.html).
* [developer guide](https://guide.convergence.io/models/data/real-time-boolean.html).
*
* @module Real Time Data
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/model/rt/RealTimeDate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface RealTimeDateEvents extends ObservableDateEvents {
* changes to this object.
*
* See the
* [developer guide](https://docs.convergence.io/guide/models/data/real-time-date.html)
* [developer guide](https://guide.convergence.io/models/data/real-time-date.html)
* for the most common use cases.
*
* @module Real Time Data
Expand Down
6 changes: 3 additions & 3 deletions src/main/model/rt/RealTimeElement.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface RealTimeElementEvents extends ObservableElementEvents {
* all data elements, like getting the element's [[value]], a unique [[id]], its
* [[path]] within the complete data tree, and much more.
*
* See the [developer guide](https://docs.convergence.io/guide/models/data/real-time-elements.html)
* See the [developer guide](https://guide.convergence.io/models/data/real-time-elements.html)
* for a more in-depth analysis of the potential types of data this could wrap.
*
* Use [[value]] to get the current actual value of this element.
Expand Down Expand Up @@ -247,7 +247,7 @@ export abstract class RealTimeElement<T = any>

/**
* True if the element is no longer synchronizing with the server. See the
* [developer guide](https://docs.convergence.io/guide/models/data/real-time-elements.html)
* [developer guide](https://guide.convergence.io/models/data/real-time-elements.html)
* for more information.
*/
public isDetached(): boolean {
Expand Down Expand Up @@ -306,7 +306,7 @@ export abstract class RealTimeElement<T = any>
* Returns the remote [[ModelReference]] created by the given `sessionId` with
* the unique name `key`, or `undefined` if no such reference exists.
*
* See [Remote References](https://docs.convergence.io/guide/models/references/remote-references.html)
* See [Remote References](https://guide.convergence.io/models/references/remote-references.html)
* in the developer guide.
*
* @param sessionId The session ID that created the reference
Expand Down

0 comments on commit 95a06a9

Please sign in to comment.