You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Consolidate SDK pages under a single "SDKs" navigation group
Move JS SDK, React, iOS SDK, and Android SDK docs into docs/sdks/
with a new group landing page and ProseMirror placeholder. Update
all internal links across 27 files to reflect the new paths.
* Update footer and mobile nav to link to SDKs group page
Change "JS SDK" link to "SDKs" pointing to /docs/sdks in both
the footer and mobile navigation dropdown.
* Add ProseMirror SDK guide with full documentation
Cover installation, quick start, configuration, mark mapping,
remote cursors, sync internals, and lower-level utilities for
the @yorkie-js/prosemirror package.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/advanced/projects.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ A **Project** in Yorkie is a logical grouping that isolates documents, channels,
9
9
10
10
### Overview
11
11
12
-
Every Yorkie installation starts with a `default` project that is created automatically. When a [Client](/docs/js-sdk#client) connects without specifying an API key, it is placed in the default project. For production applications, you should create dedicated projects to isolate data and configure settings independently.
12
+
Every Yorkie installation starts with a `default` project that is created automatically. When a [Client](/docs/sdks/js-sdk#client) connects without specifying an API key, it is placed in the default project. For production applications, you should create dedicated projects to isolate data and configure settings independently.
13
13
14
14
```mermaid
15
15
graph TB
@@ -47,7 +47,7 @@ Each project has two keys:
47
47
48
48
| Key | Purpose | Usage |
49
49
|-----|---------|-------|
50
-
|**Public Key**| Identifies the project for client connections | Used as `apiKey` when creating a [Client](/docs/js-sdk#client)|
50
+
|**Public Key**| Identifies the project for client connections | Used as `apiKey` when creating a [Client](/docs/sdks/js-sdk#client)|
51
51
|**Secret Key**| Authenticates server-side applications | Used in the `authorization` header for [Admin API](/docs/tools/admin-api) requests |
52
52
53
53
```javascript
@@ -121,8 +121,8 @@ Each project can be independently configured with the following settings:
|**Event Webhook**| Notification endpoint for document events |[Event Webhook](/docs/advanced/event-webhook)|
123
123
|**Allowed Origins**| CORS restrictions for client connections |[Security: Allowed Origins](/docs/advanced/security#allowed-origins)|
124
-
|**Max Attachments**| Maximum clients that can attach to a single document |[Document Limits](/docs/js-sdk#document-limits)|
125
-
|**Max Subscribers**| Maximum clients that can subscribe to a single document |[Document Limits](/docs/js-sdk#document-limits)|
124
+
|**Max Attachments**| Maximum clients that can attach to a single document |[Document Limits](/docs/sdks/js-sdk#document-limits)|
125
+
|**Max Subscribers**| Maximum clients that can subscribe to a single document |[Document Limits](/docs/sdks/js-sdk#document-limits)|
126
126
|**Client Deactivate Threshold**| Time after which inactive clients are automatically deactivated by [Housekeeping](/docs/internals/housekeeping)|[CLI](/docs/tools/cli#updating-the-project)|
When a client receives a snapshot instead of incremental changes, a `snapshot` event is triggered. Your application should handle this event to update its state. See [Document Events](/docs/js-sdk#documentsubscribesnapshot) for more details.
98
+
When a client receives a snapshot instead of incremental changes, a `snapshot` event is triggered. Your application should handle this event to update its state. See [Document Events](/docs/sdks/js-sdk#documentsubscribesnapshot) for more details.
0 commit comments