Add readme for h3 example - #986
Conversation
Assisted-by: ChatGPT:GPT-5.5-mini
…com/m2nsp/fedify into issue-882-add-readme-for-h3-example
✅ Deploy Preview for fedify-json-schema canceled.
|
📝 WalkthroughWalkthroughAdded a README for the Fedify–H3 integration example. The README describes the example and provides local setup, startup, and actor URL 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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
| 1. Clone the repository: | ||
|
|
||
| ~~~~ sh | ||
| git clone https://github.com/fedify-dev/fedify.git | ||
| ~~~~ | ||
|
|
||
| 2. Move to the example folder: | ||
|
|
||
| ~~~~ sh | ||
| cd examples/h3 | ||
| ~~~~ |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Enter the cloned repository before changing to the example directory.
Line 16 creates a fedify directory, but Line 22 runs from the original directory. Change Line 22 to cd fedify/examples/h3, or add cd fedify before it.
Proposed fix
2. Move to the example folder:
~~~~ sh
- cd examples/h3
+ cd fedify/examples/h3
~~~~📝 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.
| 1. Clone the repository: | |
| ~~~~ sh | |
| git clone https://github.com/fedify-dev/fedify.git | |
| ~~~~ | |
| 2. Move to the example folder: | |
| ~~~~ sh | |
| cd examples/h3 | |
| ~~~~ | |
| 1. Clone the repository: | |
| ~~~~ sh | |
| git clone https://github.com/fedify-dev/fedify.git | |
| ~~~~ | |
| 2. Move to the example folder: | |
| ~~~~ sh | |
| cd fedify/examples/h3 | |
| ~~~~ |
🤖 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 `@examples/h3/README.md` around lines 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.
| 5. Look up the actor URL: | ||
|
|
||
| ~~~~ | ||
| http://localhost:8000/users/{identifier} | ||
| ~~~~ |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify a language for the actor URL code fence.
Add a language identifier to the opening fence. This resolves the reported MD040 warning.
Proposed fix
- ~~~~
+ ~~~~ text
http://localhost:8000/users/{identifier}
~~~~📝 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.
| 5. Look up the actor URL: | |
| ~~~~ | |
| http://localhost:8000/users/{identifier} | |
| ~~~~ | |
| 5. Look up the actor URL: | |
| ~~~~ text | |
| http://localhost:8000/users/{identifier} | |
| ~~~~ |
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 39-39: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@examples/h3/README.md` around lines 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.
Source: Linters/SAST tools
1 participant
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.