Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/Layout/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export function Footer({ shortFooter }: { shortFooter?: boolean }): ReactElement
</Link>
</li>
<li className="site_item">
<Link href="/docs/js-sdk" className="link">
JS SDK
<Link href="/docs/sdks" className="link">
SDKs
</Link>
</li>
<li className="site_item">
Expand Down
6 changes: 3 additions & 3 deletions components/Layout/MobileGnbDropdown.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ export function MobileGnbDropdown({ isLoggedIn }: { isLoggedIn: boolean }) {
</li>
<li className="navigator_group">
<Link
href="/docs/js-sdk"
href="/docs/sdks"
className={classNames('navigator_item', 'add_icon', {
is_active: asPath.startsWith(`/docs/js-sdk`),
is_active: asPath.startsWith(`/docs/sdks`),
})}
>
JS SDK
SDKs
</Link>
</li>
<li className="navigator_group">
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ This section covers configuration and integration topics for building production
Before exploring these topics, ensure you have:
1. Completed the [Getting Started guide](/docs/getting-started)
2. Built at least one application using Yorkie SDKs
3. Understood basic concepts like [Client](/docs/js-sdk#client), [Document](/docs/js-sdk#document), and [Channel](/docs/js-sdk#channel)
3. Understood basic concepts like [Client](/docs/sdks/js-sdk#client), [Document](/docs/sdks/js-sdk#document), and [Channel](/docs/sdks/js-sdk#channel)
4. Reviewed key terms in the [Glossary](/docs/glossary)
10 changes: 5 additions & 5 deletions docs/advanced/architecture-patterns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Understanding these patterns will help you design the optimal architecture for y

If you're new to Yorkie, we recommend:
1. Complete the [Getting Started guide](/docs/getting-started) first
2. Understand basic [Client](/docs/js-sdk#client) and [Document](/docs/js-sdk#document) concepts
2. Understand basic [Client](/docs/sdks/js-sdk#client) and [Document](/docs/sdks/js-sdk#document) concepts
3. Familiarize yourself with key terms in the [Glossary](/docs/glossary)
4. Then return here to choose your architecture pattern

Expand Down Expand Up @@ -52,7 +52,7 @@ sequenceDiagram
2. Server creates a new document through [Yorkie Admin API](/docs/tools/admin-api#post-yorkiev1adminservicecreatedocument)
3. Server stores document metadata in your database
4. Server returns document key to client
5. Client [attaches](/docs/js-sdk#attaching-the-document) to the document using the provided key
5. Client [attaches](/docs/sdks/js-sdk#attaching-the-document) to the document using the provided key

**Document Editing Flow:**

Expand Down Expand Up @@ -159,7 +159,7 @@ sequenceDiagram

1. Client requests document key and initial content from your server
2. Client creates document locally with received key
3. Client attaches document with initial content using the [`initialRoot`](/docs/js-sdk#initializing-root) option:
3. Client attaches document with initial content using the [`initialRoot`](/docs/sdks/js-sdk#initializing-root) option:

```typescript
const doc = new yorkie.Document(key); // Key received from server
Expand Down Expand Up @@ -214,7 +214,7 @@ sequenceDiagram
Y-->>C: Detach confirmed
```

1. Client finishes editing and [detaches](/docs/js-sdk#detaching-the-document) from document
1. Client finishes editing and [detaches](/docs/sdks/js-sdk#detaching-the-document) from document
2. With project-level `RemoveOnDetach` option enabled, document is automatically removed when no clients are attached
3. This automatic cleanup reduces server management overhead

Expand Down Expand Up @@ -344,7 +344,7 @@ Explore real-world examples implementing these patterns:
### Related Documentation

For more information about Yorkie's API and features:
- [JS SDK Documentation](/docs/js-sdk) - Client and Document API reference
- [JS SDK Documentation](/docs/sdks/js-sdk) - Client and Document API reference
- [Admin API](/docs/tools/admin-api) - Admin API for server-side management
- [Security Configuration](/docs/advanced/security) - Auth Webhook and access control
- [CLI](/docs/tools/cli) - Command-line tools for project management
Expand Down
8 changes: 4 additions & 4 deletions docs/advanced/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A **Project** in Yorkie is a logical grouping that isolates documents, channels,

### Overview

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.
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.

```mermaid
graph TB
Expand Down Expand Up @@ -47,7 +47,7 @@ Each project has two keys:

| Key | Purpose | Usage |
|-----|---------|-------|
| **Public Key** | Identifies the project for client connections | Used as `apiKey` when creating a [Client](/docs/js-sdk#client) |
| **Public Key** | Identifies the project for client connections | Used as `apiKey` when creating a [Client](/docs/sdks/js-sdk#client) |
| **Secret Key** | Authenticates server-side applications | Used in the `authorization` header for [Admin API](/docs/tools/admin-api) requests |

```javascript
Expand Down Expand Up @@ -121,8 +121,8 @@ Each project can be independently configured with the following settings:
| **Auth Webhook** | External authentication endpoint for validating client requests | [Security: Auth Webhook](/docs/advanced/security#auth-webhook) |
| **Event Webhook** | Notification endpoint for document events | [Event Webhook](/docs/advanced/event-webhook) |
| **Allowed Origins** | CORS restrictions for client connections | [Security: Allowed Origins](/docs/advanced/security#allowed-origins) |
| **Max Attachments** | Maximum clients that can attach to a single document | [Document Limits](/docs/js-sdk#document-limits) |
| **Max Subscribers** | Maximum clients that can subscribe to a single document | [Document Limits](/docs/js-sdk#document-limits) |
| **Max Attachments** | Maximum clients that can attach to a single document | [Document Limits](/docs/sdks/js-sdk#document-limits) |
| **Max Subscribers** | Maximum clients that can subscribe to a single document | [Document Limits](/docs/sdks/js-sdk#document-limits) |
| **Client Deactivate Threshold** | Time after which inactive clients are automatically deactivated by [Housekeeping](/docs/internals/housekeeping) | [CLI](/docs/tools/cli#updating-the-project) |

### Common Patterns
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ yorkie project update [project-name] \
```

<Alert status="info">
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.
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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

# Look for all headings in js-sdk.mdx that might match the anchor
rg -n '^#{1,6}\s+' docs/sdks/js-sdk.mdx | grep -E -i 'subscribe|snapshot|document|changes'

Repository: yorkie-team/yorkie-team.github.io

Length of output: 298


🏁 Script executed:

# Get broader context around document subscription sections
rg -n -A2 -B2 'subscribe|snapshot' docs/sdks/js-sdk.mdx | head -100

Repository: yorkie-team/yorkie-team.github.io

Length of output: 4666


🏁 Script executed:

# Check lines 98 and 194 in resources.mdx
sed -n '96,100p; 192,196p' docs/advanced/resources.mdx

Repository: yorkie-team/yorkie-team.github.io

Length of output: 617


Change the anchor from #documentsubscribesnapshot to #subscribing-to-changes.

The anchor #documentsubscribesnapshot does not exist in docs/sdks/js-sdk.mdx. The document subscription and snapshot event handling are covered under the "#### Subscribing to Changes" heading (line 364), which generates the anchor #subscribing-to-changes. Update both lines 98 and 194 to use the correct anchor.

🤖 Prompt for AI Agents
In `@docs/advanced/resources.mdx` at line 98, Replace the incorrect anchor link
"#documentsubscribesnapshot" with the correct anchor "#subscribing-to-changes"
in the two occurrences found in the document (the links that reference the
"Document Events" / snapshot handling section); update both instances so the
text points to "#subscribing-to-changes" to match the "#### Subscribing to
Changes" heading.

</Alert>

#### SnapshotInterval
Expand Down Expand Up @@ -191,4 +191,4 @@ yorkie project update my-project \
- [CLI Reference](/docs/tools/cli) - Complete CLI command reference
- [Admin API](/docs/tools/admin-api) - API for project management
- [Architecture Patterns](/docs/advanced/architecture-patterns) - Document lifecycle patterns
- [JS SDK - Document Events](/docs/js-sdk#documentsubscribesnapshot) - Handling snapshot events
- [JS SDK - Document Events](/docs/sdks/js-sdk#documentsubscribesnapshot) - Handling snapshot events
6 changes: 3 additions & 3 deletions docs/advanced/revisions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Revisions are immutable snapshots of a document's state stored on the server. Ea
### Before You Begin

This guide assumes familiarity with:
1. [Client](/docs/js-sdk#client) and [Document](/docs/js-sdk#document) basics
1. [Client](/docs/sdks/js-sdk#client) and [Document](/docs/sdks/js-sdk#document) basics
2. [YSON format](/docs/internals/yson) for understanding snapshots

### How Revisions Work
Expand Down Expand Up @@ -57,7 +57,7 @@ When you create a revision:

### API Reference

For detailed API documentation, see [JS SDK - Document Revisions](/docs/js-sdk#document-revisions).
For detailed API documentation, see [JS SDK - Document Revisions](/docs/sdks/js-sdk#document-revisions).

| Method | Description |
|--------|-------------|
Expand Down Expand Up @@ -340,7 +340,7 @@ Revision operations require appropriate document permissions:

### Related Documentation

- [JS SDK - Document Revisions](/docs/js-sdk#document-revisions) - Complete API reference
- [JS SDK - Document Revisions](/docs/sdks/js-sdk#document-revisions) - Complete API reference
- [YSON](/docs/internals/yson) - Understanding snapshot format
- [Resources](/docs/advanced/resources) - Project configuration including auto-revisions
- [CodePair](https://github.com/yorkie-team/codepair) - Reference implementation
2 changes: 1 addition & 1 deletion docs/advanced/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Yorkie handles authentication failures based on the webhook response and HTTP st
##### Token Refresh & Retry Behavior
For `PushPull` (realtime sync) and `WatchDocuments`:
- Yorkie automatically retries the request after refreshing the token
- Notifies via [`document.subscribe('auth-error')`](/docs/js-sdk#documentsubscribeauth-error)
- Notifies via [`document.subscribe('auth-error')`](/docs/sdks/js-sdk#documentsubscribeauth-error)

For other API calls:
- The system does not automatically retry; the client must manually handle the `codes.Unauthenticated` error and retry the request
2 changes: 1 addition & 1 deletion docs/getting-started/with-android-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ scope.launch {
}
```

Next, let's take a look at the [Android SDK](/docs/android-sdk).
Next, let's take a look at the [Android SDK](/docs/sdks/android-sdk).
2 changes: 1 addition & 1 deletion docs/getting-started/with-ios-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ await doc.subscribePresnece { event in
}
```

Next, let's take a look at the [iOS SDK](/docs/ios-sdk).
Next, let's take a look at the [iOS SDK](/docs/sdks/ios-sdk).
2 changes: 1 addition & 1 deletion docs/getting-started/with-js-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ doc.subscribe('presence', (event) => {
});
```

Next, let's take a look at the [JS SDK](/docs/js-sdk).
Next, let's take a look at the [JS SDK](/docs/sdks/js-sdk).
2 changes: 1 addition & 1 deletion docs/getting-started/with-react.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,5 +177,5 @@ function StandaloneTodoList() {

### For More Information

- [React Guide](/docs/js-sdk/react) - Comprehensive guide covering all providers, hooks, performance optimization, and advanced patterns
- [React Guide](/docs/sdks/react) - Comprehensive guide covering all providers, hooks, performance optimization, and advanced patterns
- [React TodoMVC Example](https://github.com/yorkie-team/yorkie-js-sdk/tree/main/examples/react-todomvc)
Loading