Repository navigation
docs: explain configurable metadata and native attachments - #4459
Conversation
ApprovabilityVerdict: 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. |
This comment has been minimized.
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 |
There was a problem hiding this comment.
Other docs use a tabbed language selector. Prefer that
78a879d to
631bf8f
Compare
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 }, |
There was a problem hiding this comment.
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
|
8.0.0 documentation tracking: #4704 (Overhaul docs site for 8.0.0 SDK). This merged PR is included in the completed implementation list. |
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_IMAGEbyte 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
apps/docs/examples/USER_PRONOUNSexample component ID shifts in the run-the-backend registry example; existing registered fields keep their definitions, but the oldattachments.mdpage is deleted in favor of the MDX versionMacroscope summarized 631bf8f.