Skip to content

docs: explain configurable metadata and native attachments - #4459

Merged
neekolas merged 5 commits into
self-hostedfrom
codex/docs-metadata-attachments
Oct 7, 2026
Merged

neekolas merged 5 commits into
self-hostedfrom
codex/docs-metadata-attachments

Conversation

@neekolas

@neekolas neekolas commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

The docs mention configurable metadata and managed attachments but do not show the full application workflow. This change adds group and user field configuration, typed discovery and updates, field policies and limits, and the separate GROUP_IMAGE byte field.

The attachment guide now shows Kotlin and Swift creation, message sending, upload, and download calls. It explains pending status, restart recovery, explicit downloads, retry causes, events, and local file deletion. The storage guide links to this workflow and explains encrypted upload size and remote retention.

Metadata and native attachment examples use synchronized Browser, Node, Kotlin, and Swift tabs. Browser and Node examples are checked against the local SDK declarations. Repeated examples have lower search weight, and the guide-title weight keeps the Conversations guide first for group chat.

Validation:

  • dev/nix-shell 'just docs build' (includes all 46 TypeScript example checks)
  • dev/nix-shell 'just docs lint'
  • dev/nix-shell 'just docs format-check'
  • dev/nix-shell 'just docs test'
  • dev/nix-shell 'DOCS_SKIP_NATIVE_REFERENCES=1 just docs test-browser'
  • dev/nix-shell 'DOCS_SKIP_NATIVE_REFERENCES=1 just docs compose'
  • dev/nix-shell 'DOCS_SKIP_NATIVE_REFERENCES=1 just docs check'
  • dev/nix-shell 'DOCS_SKIP_NATIVE_REFERENCES=1 just docs check-external'

Kotlin and Swift snippets were checked against the current public SDK source and native tests. The docs build does not compile these snippets.

Note

Document native attachments and configurable metadata fields

  • Rewrites the attachments page in MDX with native SDK upload/download examples for Browser, Node, Kotlin, and Swift, covering upload ordering, retry, pending-storage operations, cleanup, and events in attachments.mdx
  • Adds a configurable group fields guide with typed reads/writes, policy and size limits, user-data updates, and sync examples in groups.mdx, plus new Browser/Node example files in apps/docs/examples/
  • Extends the backend guide with the application-component registry, field mutability and ID ranges, and encrypted fields in run-the-backend.mdx
  • Adds a deployment guide for SDK-managed attachment upload and signed-PUT ciphertext transfer in attachment-storage.md
  • Raises guide-title search weight from 100 to 1000 in search-config.mjs
  • Risk: USER_PRONOUNS example component ID shifts in the run-the-backend registry example; existing registered fields keep their definitions, but the old attachments.md page is deleted in favor of the MDX version

Macroscope summarized 631bf8f.

@neekolas
neekolas requested review from a team as code owners October 7, 2026 02:17
macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Oct 7, 2026
@macroscopeapp

macroscopeapp Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Approvability

Verdict: Not approved

Macroscope's review found this PR not approvable — The PR is mostly documentation and SDK examples, with no implementation or protocol changes, but it also changes the docs site's global search ranking. An unresolved Code Quality finding reports that this change makes multiple queries return the wrong first result, so the ranking needs correction and browser search verification before approval.

You can add or adjust custom eligibility rules. Learn more.

@blacksmith-sh

This comment has been minimized.

`GROUP_CATEGORY` and `USER_PRONOUNS` as shown in the backend guide. The group
must have registered them, and the caller must be an admin to set the category.

#### Kotlin

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Other docs use a tabbed language selector. Prefer that

@neekolas
neekolas force-pushed the codex/docs-metadata-attachments branch from 78a879d to 631bf8f Compare October 7, 2026 20:52
@macroscopeapp
macroscopeapp Bot dismissed their stale review October 7, 2026 20:52

Dismissing prior approval to re-evaluate 631bf8f

termSimilarity: 9,
// Keep guide title matches above repeated terms in longer guide bodies.
metaWeights: { title: 0, guideTitle: 100 },
metaWeights: { title: 0, guideTitle: 1000 },

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This global 10× guide-title boost is causing the search-ranking checks to return the wrong first page for multiple queries. Could you tune the ranking more narrowly so the group chat case is fixed without regressing the other expected results, then rerun the browser search tests?

Posted via Macroscope — Code Quality

@neekolas
neekolas merged commit 9d96c4e into self-hosted Oct 7, 2026
51 checks passed
@neekolas
neekolas deleted the codex/docs-metadata-attachments branch October 7, 2026 21:19

Copy link
Copy Markdown
Contributor Author

8.0.0 documentation tracking: #4704 (Overhaul docs site for 8.0.0 SDK).

This merged PR is included in the completed implementation list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant