Skip to content

Add readme for h3 example - #986

Open
m2nsp wants to merge 4 commits into
fedify-dev:mainfrom
m2nsp:issue-882-add-readme-for-h3-example
Open

Add readme for h3 example#986
m2nsp wants to merge 4 commits into
fedify-dev:mainfrom
m2nsp:issue-882-add-readme-for-h3-example

Conversation

@m2nsp

@m2nsp m2nsp commented Aug 7, 2026

Copy link
Copy Markdown

Summary

  • Add examples/h3/README.md to document the H3 example.

Fixes #882

Test plan

  • hongdown --check examples/h3/README.md

AI disclosure

This change was written with assistance from ChatGPT (GPT-5.5-mini), reviewed and verified by me.

@m2nsp
m2nsp requested a review from 2chanhaeng as a code owner August 7, 2026 15:14
@netlify

netlify Bot commented Aug 7, 2026

Copy link
Copy Markdown

Deploy Preview for fedify-json-schema canceled.

Name Link
🔨 Latest commit 05e3a6c
🔍 Latest deploy log https://app.netlify.com/projects/fedify-json-schema/deploys/6a79e4afd210040008106576

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

An error occurred during the review process. Please try again later.

📝 Walkthrough

Walkthrough

Added a README for the Fedify–H3 integration example. The README describes the example and provides local setup, startup, and actor URL instructions.

Changes

H3 example documentation

Layer / File(s) Summary
Document H3 example setup
examples/h3/README.md
Adds a description and five steps to clone the repository, enter the example directory, install dependencies with pnpm, start the Deno server, and access an actor URL.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related issues

  • Issue 884 — Documents the same examples/h3 integration in a different README.

Possibly related PRs

Suggested reviewers: 2chanhaeng

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the addition of documentation for the H3 example.
Description check ✅ Passed The description accurately explains the README addition and its validation command.
Linked Issues check ✅ Passed The README covers the H3 example description, setup steps, run command, and actor URL lookup required by issue #882.
Out of Scope Changes check ✅ Passed The changes are limited to the README requested for the H3 example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 15ad151 and 615e11b.

📒 Files selected for processing (1)
  • examples/h3/README.md

Comment thread examples/h3/README.md
Comment thread examples/h3/README.md Outdated

@2chanhaeng 2chanhaeng left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the example flow should be clearer.

  1. Clone the repository
  2. Go to the directory of the cloned repository
  3. Trust and install dependencies using mise
  4. Go to the h3 example directory
  5. Open the server using Deno
  6. Lookup an actor using @fedify/cli

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a README for the h3 example

2 participants