Enhance pragmatics documentation with new sections and examples - #948
Conversation
✅ Deploy Preview for fedify-json-schema canceled.
|
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
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
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
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
dahlia
left a comment
There was a problem hiding this comment.
Please correct the three factual issues in the inline comments before this is merged. Please also link #946 from the pull request description so the accepted issue is visible from the pull request.
If an AI tool assisted with any part of this work, please name the tool and describe the extent of its assistance in the pull request description. Please read and follow AI_POLICY.md, and add an Assisted-by: AGENT_NAME:MODEL_VERSION trailer to every affected commit message.
Explain primary and secondary audience addressing, multi-recipient fields, and the public-post example. Assisted-by: OpenCode:gpt-5.6-terra
Document reply threading, audience addressing, and matching mention metadata. Assisted-by: OpenCode:gpt-5.6-terra
Document Microformats classes for mentions and hashtags alongside ActivityPub tag metadata. Assisted-by: OpenCode:gpt-5.6-terra
…ation Document FEP-044f quote policies and authorization flow, including legacy quote compatibility. Assisted-by: OpenCode:gpt-5.6-terra
Separate thread linkage from audience delivery and mention notifications in the reply guidance. fedify-dev#948 (comment) Assisted-by: OpenCode:gpt-5.6-terra
Replace the nonexistent quote accessor with the supported object-loading API. fedify-dev#948 (comment) Assisted-by: OpenCode:gpt-5.6-terra
Remove the unsupported claim that Microformats classes improve inbound interoperability with Misskey. fedify-dev#948 (comment) Assisted-by: OpenCode:gpt-5.6-terra
41cb247 to
22b03d3
Compare
|
I wrote this by researching as much as I could with the help of AI, but it seems there were a few issues. I'll make sure to do more thorough research before working on it next time. My apologies. I've added the explanation and "Assisted-by" tag to the PR description and commit message. I also fixed the issues mentioned above, so please take another look. |
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 878-889: Clarify the mention-markup documentation by explicitly
distinguishing the minimal Mastodon-compatible `mention u-url` form from the
full Microformats 2 structure using `h-card`, `p-name`, and `u-url`, with
`mention` as an additional class. Update the surrounding examples or explanatory
text consistently, preserving the documented full-form behavior in the section
around the HTML example.
🪄 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 Plus
Run ID: 6aba92d8-7681-401a-b8e9-6fcdcd7127c3
📒 Files selected for processing (1)
docs/manual/pragmatics.md
Close #946
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 compatibility.Microformats: