Add readme for h3 example - #986
Conversation
✅ Deploy Preview for fedify-json-schema canceled.
|
📝 WalkthroughWalkthroughAdded a README for the Fedify–H3 integration example. The README describes the integration and provides repository setup, server startup, and actor URL lookup instructions. ChangesH3 example documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related issues
Possibly related PRs
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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@examples/h3/README.md`:
- Around line 13-23: Update the setup instructions in the h3 README so the
example-directory command enters the cloned repository first, using cd
fedify/examples/h3 or an equivalent preceding cd fedify step before the existing
examples/h3 path.
- Around line 37-41: Update the actor URL code fence in the README instructions
to include an appropriate language identifier on its opening fence, resolving
the MD040 warning while leaving the URL content unchanged.
🪄 Autofix
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: 966f2b23-94eb-49a3-b3bd-435aee853162
📒 Files selected for processing (1)
examples/h3/README.md
2chanhaeng
left a comment
There was a problem hiding this comment.
I think the example flow should be clearer.
- Clone the repository
- Go to the directory of the cloned repository
- Trust and install dependencies using
mise - Go to the
h3example directory - Open the server using Deno
- Lookup an actor using
@fedify/cli
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
2chanhaeng
left a comment
There was a problem hiding this comment.
Great work! Please apply this comment then I'll approve this PR.
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 `@examples/h3/README.md`:
- Line 44: Update the step text in the README from “Lookup an actor using
`@fedify/cli`” to “Look up an actor using `@fedify/cli`,” using the phrasal verb
form.
🪄 Autofix
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: 3432e5ab-ed94-4544-a3fa-652240ef00a0
📒 Files selected for processing (1)
examples/h3/README.md
2chanhaeng
left a comment
There was a problem hiding this comment.
Great work! Before merging this PR, please rebase from the main branch.
905a8d5 to
228c52d
Compare
2chanhaeng
left a comment
There was a problem hiding this comment.
Great work! Thanks for your contribution!
|
Before merging this PR, please rebase from the main branch. |
Assisted-by: ChatGPT:GPT-5.5-mini
Head branch was pushed to by a user without write access
228c52d to
fddeb1c
Compare
Summary
examples/h3/README.mdto document the H3 example.Fixes #882
Test plan
hongdown --check examples/h3/README.mdAI disclosure
This change was written with assistance from ChatGPT (GPT-5.5-mini), reviewed and verified by me.