Merge pull request #731 from dahlia/docs/tutorial/content-sharing

“Creating an image sharing service” tutorial

Author: dahlia

.agents/skills/add-vocab/SKILL.md

@@ -33,8 +33,8 @@ fediverse. Specifically, verify:
     async/sync interface contract
  -  The `functional` flag is correct — marking a multi-valued property as
     functional silently drops values
- -  Every property `range` entry is accurate — wrong range types produce incorrect
-    TypeScript types
+ -  Every property `range` entry is accurate — wrong range types produce
+    incorrect TypeScript types
  -  The spec document (FEP or W3C spec) has been read in full, not just skimmed
 
 Do not rely solely on automated checks (`mise run check`)—they verify only
@@ -86,8 +86,8 @@ $schema: ../../vocab-tools/schema.yaml
 **Entity vs. value type (`entity` flag):**
 
  -  `entity: true` — property accessors are `async` and can fetch remote objects
- -  `entity: false` — property accessors are synchronous; used for embedded value
-    objects (e.g. `Endpoints`, `Source`, `Hashtag`)
+ -  `entity: false` — property accessors are synchronous; used for embedded
+    value objects (e.g. `Endpoints`, `Source`, `Hashtag`)
 
 ### `defaultContext` format
 
@@ -117,8 +117,8 @@ defaultContext:
 Embedded context entries are YAML mappings where:
 
  -  String value `"prefix:term"` or `"https://..."` defines a simple term alias
- -  Object value with `"@id"` and optionally `"@type": "@id"` defines a term that
-    should be treated as an IRI (linked resource)
+ -  Object value with `"@id"` and optionally `"@type": "@id"` defines a term
+    that should be treated as an IRI (linked resource)
 
 ### Ensuring complete compaction coverage
 
@@ -128,9 +128,9 @@ document produced by `toJsonLd()`**, including:
 1.  **The type's own `compactName`** — if the type has a `compactName`, the
     context must map that name to the type's URI.
 
-2.  **All own property `compactName`s** — every property defined directly on this
-    type must have its `compactName` (or full URI fallback) resolvable via the
-    context.
+2.  **All own property `compactName`s** — every property defined directly on
+    this type must have its `compactName` (or full URI fallback) resolvable via
+    the context.
 
 3.  **Inherited properties** — properties from parent types are usually covered
     by the parent's context URL (e.g., `https://www.w3.org/ns/activitystreams`

.agents/skills/create-example-app-with-integration/SKILL.md

@@ -136,8 +136,8 @@ Follow the specifications in [ARCHITECTURE.md](./ARCHITECTURE.md) and
  -  Implement all routes listed in the “Routing” section of
     [ARCHITECTURE.md](./ARCHITECTURE.md), using `RequestContext` as described
     in the “Server-side data access” section.
- -  Render HTML pages according to [DESIGN.md](./DESIGN.md).  Serve static assets
-    from the `public/` directory (copy from
+ -  Render HTML pages according to [DESIGN.md](./DESIGN.md).  Serve static
+    assets from the `public/` directory (copy from
     [example/public/](./example/public/)).
  -  Implement the SSE endpoint per the “Server-sent events” section of
     [ARCHITECTURE.md](./ARCHITECTURE.md).

AGENTS.md

@@ -170,8 +170,9 @@ A detailed step-by-step guide is available across three skills:
 
 ### Creating database adapters
 
-1.  For core KV/MQ interfaces: implement in *packages/fedify/src/federation/kv.ts*
-    and *packages/fedify/src/federation/mq.ts*
+1.  For core KV/MQ interfaces: implement in
+    *packages/fedify/src/federation/kv.ts* and
+    *packages/fedify/src/federation/mq.ts*
 2.  For specific database adapters: create dedicated packages
     (*packages/sqlite/*, *packages/postgres/*, *packages/mysql/*,
     *packages/redis/*, *packages/amqp/*)

CHANGES.md

@@ -243,6 +243,17 @@ To be released.
     redistribution that threadiverse software (Lemmy, Mbin, NodeBB) uses to fan
     activity out to every subscriber.  [[#704], [#710]]
 
+ -  Added [*Creating an image sharing service* tutorial], a Pixelfed-style
+    image-sharing companion to the microblog walk-through.  Built on Nuxt 4
+    and the new `@fedify/nuxt` integration, the tutorial covers actor
+    dispatchers, key pairs, follow/unfollow flows, image-bearing
+    `Create(Note)` fan-out and reception, an outbound `Like`/`Undo(Like)`
+    heart toggle, and threaded comments through `inReplyTo`.  The
+    [companion example repository] keeps one commit per chapter at the
+    bottom of its log, with a few rehearsal-driven follow-ups landed on top,
+    and the federation flows are demonstrated against both Mastodon and
+    Pixelfed.  [[#693]]
+
  -  Added a custom collections cookbook example for bookmark-like data,
     demonstrating cursor pagination, URI-template filtering, collection
     counters, actor stream links, and requester-aware collections using
@@ -253,7 +264,10 @@ To be released.
 [Bun]: https://bun.sh/
 [*Building a threadiverse community platform*]: https://fedify.dev/tutorial/threadiverse
 [*Creating your own federated microblog*]: https://fedify.dev/tutorial/microblog
+[*Creating an image sharing service* tutorial]: https://fedify.dev/tutorial/content-sharing
+[companion example repository]: https://github.com/fedify-dev/content-sharing
 [#691]: https://github.com/fedify-dev/fedify/issues/691
+[#693]: https://github.com/fedify-dev/fedify/issues/693
 [#694]: https://github.com/fedify-dev/fedify/issues/694
 [#695]: https://github.com/fedify-dev/fedify/pull/695
 [#704]: https://github.com/fedify-dev/fedify/issues/704
@@ -1061,8 +1075,8 @@ Released on February 22, 2026.
     to the standardized `Intl.Locale` class for representing language tags.
     [[#280], [#392] by Jang Hanarae]
 
-     -  The `LanguageString.language` property is now `LanguageString.locale` and
-        is of type `Intl.Locale` instead of `LanguageTag`.
+     -  The `LanguageString.language` property is now `LanguageString.locale`
+        and is of type `Intl.Locale` instead of `LanguageTag`.
      -  The `LanguageString` constructor now accepts either an `Intl.Locale`
         object or a string for the language parameter.
      -  The `Link.language` property is now of type `Intl.Locale` instead
@@ -1782,8 +1796,8 @@ Released on December 24, 2025.
 
 ### @fedify/nestjs
 
- -  Allowed Express 5 in the `express` peer dependency range to support NestJS 11.
-    [[#492], [#493] by Cho Hasang]
+ -  Allowed Express 5 in the `express` peer dependency range to support NestJS
+    11. [[#492], [#493] by Cho Hasang]
 
 [#492]: https://github.com/fedify-dev/fedify/issues/492
 [#493]: https://github.com/fedify-dev/fedify/pull/493
@@ -4083,8 +4097,9 @@ Released on November 30, 2024.
 
  -  The `Router` now provide the matched route's URI template besides the name.
 
-     -  The return type of `Router.route()` method became `RouterRouteResult | null`
-        (was `{ name: string; values: Record<string, string> } | null`).
+     -  The return type of `Router.route()` method became
+        `RouterRouteResult | null` (was
+        `{ name: string; values: Record<string, string> } | null`).
      -  Added `RouterRouteResult` interface.
 
  -  Added `getTypeId()` function.
@@ -5733,8 +5748,8 @@ Released on September 26, 2024.
 
  -  Added options for PostgreSQL drivers to `fedify init` command.
 
-     -  Added `postgres` value to the `-k`/`--kv-store` option of the `fedify init`
-        command.
+     -  Added `postgres` value to the `-k`/`--kv-store` option of the
+        `fedify init` command.
      -  Added `postgres` value to the `-q`/`--message-queue` option of
         the `fedify init` command.
 

CONTRIBUTING.md

@@ -244,7 +244,8 @@ Because this project supports both Deno and Node.js/Bun, dependencies must
 be added to *both* configuration files:
 
  -  *deno.json*: Add to the `imports` field (for Deno).
- -  *package.json*: Add to `dependencies` or `devDependencies` (for Node.js/Bun).
+ -  *package.json*: Add to `dependencies` or `devDependencies` (for
+    Node.js/Bun).
 
 For workspace packages, use the pnpm catalog (*pnpm-workspace.yaml*) to manage
 versions centrally.  In *package.json*, reference catalog versions with
@@ -371,10 +372,10 @@ The repository is organized as a monorepo with the following packages:
     creating new Fedify projects.  Wraps @fedify/init.
  -  *packages/amqp/*: AMQP/RabbitMQ driver (@fedify/amqp) for Fedify.
  -  *packages/astro/*: Astro integration (@fedify/astro) for Fedify.
- -  *packages/cfworkers/*: Cloudflare Workers integration (@fedify/cfworkers) for
-    Fedify.
- -  *packages/debugger/*: Embedded ActivityPub debug dashboard (@fedify/debugger)
+ -  *packages/cfworkers/*: Cloudflare Workers integration (@fedify/cfworkers)
     for Fedify.
+ -  *packages/debugger/*: Embedded ActivityPub debug dashboard
+    (@fedify/debugger) for Fedify.
  -  *packages/denokv/*: Deno KV integration (@fedify/denokv) for Fedify.
  -  *packages/elysia/*: Elysia integration (@fedify/elysia) for Fedify.
  -  *packages/express/*: Express integration (@fedify/express) for Fedify.

docs/.vitepress/config.mts

@@ -112,6 +112,10 @@ const TUTORIAL = {
     },
     { text: "Learning the basics", link: "/tutorial/basics.md" },
     { text: "Creating a microblog", link: "/tutorial/microblog.md" },
+    {
+      text: "Creating an image sharing service",
+      link: "/tutorial/content-sharing.md",
+    },
     { text: "Building a federated blog", link: "/tutorial/astro-blog.md" },
     {
       text: "Building a threadiverse community",

docs/manual/collections.md

@@ -1567,7 +1567,8 @@ Custom collections support the same callback methods as built-in collections:
 
  -  **`.setCounter()`**: Sets a callback that returns the total number of items
     in the collection
- -  **`.setFirstCursor()`**: Sets the cursor for the first page of the collection
+ -  **`.setFirstCursor()`**: Sets the cursor for the first page of the
+    collection
  -  **`.setLastCursor()`**: Sets the cursor for the last page of the collection
  -  **`.authorize()`**: Sets an authorization predicate to control access to
     the collection

docs/manual/deploy.md

@@ -740,10 +740,10 @@ systemd
     (`systemctl start fedify@web.service fedify@worker.service`).
 
 Kubernetes
-:   Two `Deployment`s.  Only the web `Deployment` gets a `Service` and `Ingress`.
-    Scale workers on queue depth (via a custom metric adapter reading from
-    your MQ backend) rather than CPU—a queue that's falling behind is not
-    necessarily CPU-bound.
+:   Two `Deployment`s.  Only the web `Deployment` gets a `Service` and
+    `Ingress`. Scale workers on queue depth (via a custom metric adapter
+    reading from your MQ backend) rather than CPU—a queue that's falling behind
+    is not necessarily CPU-bound.
 
 > [!WARNING]
 > Do not place worker nodes behind a load balancer or expose them on a
@@ -1214,10 +1214,10 @@ Block abusive instances early
     your own rather than importing them wholesale.
 
 Keep the system clock in sync
-:   HTTP signatures are valid only within `~FederationOptions.signatureTimeWindow`
-    (one hour by default).  Run NTP on every web and worker node.  Clock
-    drift is the second-most-common “it worked in staging” production
-    issue after reverse-proxy misconfiguration.
+:   HTTP signatures are valid only within
+    `~FederationOptions.signatureTimeWindow` (one hour by default).  Run NTP on
+    every web and worker node.  Clock drift is the second-most-common “it
+    worked in staging” production issue after reverse-proxy misconfiguration.
 
 [Pelago]: https://pelago.1sland.social/blocklist
 [FIRES]: https://fires.fedimod.org/

docs/manual/mq.md

@@ -538,8 +538,8 @@ Best for
 :   Production use in Cloudflare Workers environments.
 
 Pros
-:   Persistent, reliable, scalable, easy to set up, native retry with exponential
-    backoff and dead-letter queues.
+:   Persistent, reliable, scalable, easy to set up, native retry with
+    exponential backoff and dead-letter queues.
 
 Cons
 :   Only available in Cloudflare Workers runtime.

docs/manual/relay.md

@@ -132,7 +132,8 @@ Configuration options
     keys.
 
 `origin` (required)
-:   The origin URL where the relay is hosted (e.g., `"https://relay.example.com"`).
+:   The origin URL where the relay is hosted (e.g.,
+    `"https://relay.example.com"`).
 
 `name`
 :   Display name for the relay actor. Defaults to `"ActivityPub Relay"`.