Skip to content

List the h3 example in the examples index - #975

Merged
dahlia merged 1 commit into
fedify-dev:mainfrom
lntutor:docs/list-h3-example
Jul 31, 2026
Merged

List the h3 example in the examples index#975
dahlia merged 1 commit into
fedify-dev:mainfrom
lntutor:docs/list-h3-example

Conversation

@lntutor

@lntutor lntutor commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

The h3 example was easy to miss because examples/README.md did not list it. This adds the existing example to the index with a short description of the H3 integration it demonstrates.

Closes #884

Verification

  • /tmp/hongdown --check examples/README.md
  • git diff --check
  • Confirmed the link target contains the H3 application and Fedify integration source files

AI assistance

OpenAI Codex (gpt-5.6) assisted with repository policy review, wording, and validation commands. I reviewed the final diff and ran the repository-pinned Hongdown 0.5.3 check locally.

Make the existing h3 integration example discoverable from the examples index.

Assisted-by: Codex:gpt-5.6
@lntutor
lntutor requested a review from 2chanhaeng as a code owner July 31, 2026 13:22
@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for fedify-json-schema canceled.

Name Link
🔨 Latest commit 54cf043
🔍 Latest deploy log https://app.netlify.com/projects/fedify-json-schema/deploys/6a6ca190e0409b00095c3b71

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3357da46-c6d1-4e1d-81a1-4de203da0782

📥 Commits

Reviewing files that changed from the base of the PR and between 32e9952 and 54cf043.

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

📝 Walkthrough

Walkthrough

The examples index now includes an H3 integration example with a link and description.

Changes

H3 example index

Layer / File(s) Summary
Add H3 example entry
examples/README.md
The examples README links to ./h3/ and describes federation served through an H3 application.

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

Suggested reviewers: 2chanhaeng, dahlia

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that the H3 example will be added to the examples index.
Description check ✅ Passed The description directly explains the documentation change, validation steps, and linked issue.
Linked Issues check ✅ Passed The PR adds examples/h3 to examples/README.md with a relevant description, satisfying issue #884.
Out of Scope Changes check ✅ Passed The changes are limited to documenting the existing H3 example and validating the documentation.
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.

@dahlia
dahlia merged commit 9b6f025 into fedify-dev:main Jul 31, 2026
5 checks passed
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.

List the h3 example in the examples index

2 participants