Skip to content

Add readme for h3 example #986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
m2nsp wants to merge 3 commits into
base: main
Choose a base branch
from
+41 −0
Open

Add readme for h3 example #986

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b3aa41
add README for H3 example
m2nsp Aug 7, 2026
c778193
Add README for H3 example
m2nsp Aug 7, 2026
615e11b
Merge branch 'issue-882-add-readme-for-h3-example' of https://github.…
m2nsp Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions examples/h3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Fedify–H3 integration example
=============================

This is a simple example of how to integrate Fedify into an [H3]
application.

[H3]: https://h3.unjs.io/


Running the example
-------------------

1. Clone the repository:

~~~~ sh
git clone https://github.com/fedify-dev/fedify.git
~~~~

2. Move to the example folder:

~~~~ sh
cd examples/h3
~~~~
Comment on lines +13 to +23

@coderabbitai coderabbitai Bot Aug 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 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.

Suggested change
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.


3. Install dependencies:

~~~~ sh
pnpm install
~~~~

4. Start the server:

~~~~ sh
deno serve -A index.ts
~~~~

5. Look up the actor URL:

~~~~
http://localhost:8000/users/{identifier}
~~~~
Comment on lines +37 to +41

@coderabbitai coderabbitai Bot Aug 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 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.

Suggested change
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