From 1050738e07b0ee7d467b83ec71e841c08f9c3e0a Mon Sep 17 00:00:00 2001 From: Brendan O'Brien Date: Sat, 12 Apr 2025 12:51:55 -0400 Subject: [PATCH] fix broken docs link ticket --- src/app/docs/concepts/tickets/page.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/app/docs/concepts/tickets/page.mdx b/src/app/docs/concepts/tickets/page.mdx index 74f4cee..538be72 100644 --- a/src/app/docs/concepts/tickets/page.mdx +++ b/src/app/docs/concepts/tickets/page.mdx @@ -26,7 +26,7 @@ Currently, there are three kinds of tickets: | --- | --- | --- | | `node` | A token for connecting to an iroh node | `Node Address` | | `blob` | A token for fetching a [blob](/docs/layers/blobs) or [collection](/docs/layers/blobs#collections) | `Hash`, `HashOrCollection`, `Node Address` | -| `ticket` | A read/write access token to a [document](/docs/layers/document), plus a node address | `DocID`, `Read/Write Capability`, `[Node Address]` | +| `document` | A read/write access token to a [document](/proto/iroh-docs), plus a node address | `DocID`, `Read/Write Capability`, `[Node Address]` | Tickets always start with an ascii string that describes the type of ticket (eg: `blob`), followed by a base32-lowercase-encoded payload. The payload is [postcard-encoded data](https://postcard.jamesmunns.com/wire-format.html) that contains the information needed to use the ticket. We chose postcard because it's extremely succinct. @@ -43,4 +43,4 @@ When you create a document ticket, you're creating a secret that allows someone ## Tickets in Apps Using tickets in your app comes down to what you're trying to accomplish. For short-lived sessions where both devices are online at the same time, tickets are an incredibly powerful way to bootstrap connections, and require no additinonal servers for coordination. -If you have any means of automating (like, a central database or server to bootstrap from) we recommend you _do not_ use tickets in your app, and instead program around the idea that you can _dial by NodeID_. Tickets can contain information that can go stale quickly. instead focus on caching `nodeIDs`, and letting iroh transparently resolve dialing details at runtime. \ No newline at end of file +If you have any means of automating (like, a central database or server to bootstrap from) we recommend you _do not_ use tickets in your app, and instead program around the idea that you can _dial by NodeID_. Tickets can contain information that can go stale quickly. instead focus on caching `nodeIDs`, and letting iroh transparently resolve dialing details at runtime.