Enhance pragmatics documentation with new sections and examples#948
Enhance pragmatics documentation with new sections and examples#948Bananamilk452 wants to merge 4 commits into
Conversation
✅ Deploy Preview for fedify-json-schema canceled.
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the pragmatics documentation in docs/manual/pragmatics.md by adding new sections on addressing (to and cc), handling replies, allowing quotes (including FEP-044f and legacy Misskey quotes), and using Microformats 2 for embedding metadata in HTML. Since there are no review comments, I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
📝 WalkthroughWalkthroughThe ActivityPub pragmatics manual now documents audience addressing, reply structure, quote consent policies, and Mastodon-compatible microformats with examples and interoperability guidance. ChangesActivityPub pragmatics documentation
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/manual/pragmatics.md`:
- Around line 801-804: Update the documentation paragraph to use consistent
`cc`/`ccs` terminology, and explicitly state that the enclosing `Create`
activity must copy the complete `to` and `cc` audience lists from its `Note`
object.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 8317533f-a61b-4e1e-8fe6-8ec2e337993e
📒 Files selected for processing (1)
docs/manual/pragmatics.md
| The `to` and `cc` values are audience addresses, not inbox URLs. In particular, | ||
| use the parent author's actor URL in `cc`, then deliver the `Create` activity to | ||
| that actor through `Context.sendActivity()`. Give the enclosing `Create` | ||
| activity the same `to` and `cc` values as its `Note` object. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Keep the audience field names consistent.
The example sets ccs, but this paragraph refers only to matching cc values. Say cc/ccs and explicitly preserve the complete audience list when copying the Note audience onto the enclosing Create activity.
Suggested wording
-Give the enclosing `Create` activity the same `to` and `cc` values as its `Note` object.
+Give the enclosing `Create` activity the same `to`/`tos` and `cc`/`ccs` audience values as its `Note` object.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The `to` and `cc` values are audience addresses, not inbox URLs. In particular, | |
| use the parent author's actor URL in `cc`, then deliver the `Create` activity to | |
| that actor through `Context.sendActivity()`. Give the enclosing `Create` | |
| activity the same `to` and `cc` values as its `Note` object. | |
| The `to` and `cc` values are audience addresses, not inbox URLs. In particular, | |
| use the parent author's actor URL in `cc`, then deliver the `Create` activity to | |
| that actor through `Context.sendActivity()`. Give the enclosing `Create` | |
| activity the same `to`/`tos` and `cc`/`ccs` audience values as its `Note` object. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manual/pragmatics.md` around lines 801 - 804, Update the documentation
paragraph to use consistent `cc`/`ccs` terminology, and explicitly state that
the enclosing `Create` activity must copy the complete `to` and `cc` audience
lists from its `Note` object.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
1 participant
This pull request adds comprehensive documentation to
pragmatics.mdon audience addressing, replies, quote policies, and microformats in ActivityPub objects. The new sections clarify how to use theto/ccproperties, create replies with proper audience and mentions, implement consent-respecting quote policies, and ensure interoperability with Mastodon and other platforms through microformats.Audience addressing:
toandccproperties (and their plural forms) for specifying primary and secondary recipients on ActivityPub objects, including code examples and links to further documentation.Replying and quoting:
Note.replyTarget, proper audience (to,ccs), andMentiontags, including a detailed code example. Explained requirements for Mastodon and Pixelfed compatibility.Microformats: