Skip to content

docs: surface IAPKit open-source + source link consistently#122

Merged
hyochan merged 2 commits into
mainfrom
docs/iapkit-open-source-callouts
Apr 30, 2026
Merged

docs: surface IAPKit open-source + source link consistently#122
hyochan merged 2 commits into
mainfrom
docs/iapkit-open-source-callouts

Conversation

@hyochan

@hyochan hyochan commented Apr 30, 2026

Copy link
Copy Markdown
Member

Summary

`example.tsx` and `features/validation.tsx` already note that IAPKit is open source (MIT) and link to `packages/kit`. Three other references didn't:

  • getting-started.tsx — said "open source" as plain text without a clickable source link
  • apis/index.tsx — `verifyPurchaseWithProvider` row said only "currently exposes only IAPKit" with no MIT/source mention
  • types/verify-purchase-with-provider-props.tsx — same gap on the type page

Aligned all three with the existing pattern: explicit "open source under MIT", linkable `packages/kit` source, and (where relevant) the hosted `kit.openiap.dev` mention.

Test plan

  • Local pre-commit gate (typecheck + prettier) passed.
  • Vite build succeeds.
  • Visually verify the three pages render the new wording + clickable source link.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation clarity with explicit MIT open-source attribution for the kit.
    • Added clickable links to the hosted instance and GitHub repository for easier access to source code and self-hosting options.
    • Improved cross-references throughout the documentation for better navigation and resource discovery.

example.tsx and validation.tsx already mention that IAPKit is open
source (MIT) and link to packages/kit. Bring three more references
into line so anyone landing on getting-started, the API index, or
the type page sees the same info — with a clickable source link
instead of plain text.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 10b30bc7-d46e-4a90-acab-b1077524115a

📥 Commits

Reviewing files that changed from the base of the PR and between c0824a9 and bbcbbf5.

📒 Files selected for processing (3)
  • packages/docs/src/pages/docs/apis/index.tsx
  • packages/docs/src/pages/docs/getting-started.tsx
  • packages/docs/src/pages/docs/types/verify-purchase-with-provider-props.tsx

📝 Walkthrough

Walkthrough

Documentation updates across three files add MIT open-source attribution to IAPKit references and incorporate external GitHub links to the packages/kit repository and kit.openiap.dev hosted instance for improved clarity on self-hosting and source access options.

Changes

Cohort / File(s) Summary
Documentation Attribution & Links
packages/docs/src/pages/docs/apis/index.tsx, packages/docs/src/pages/docs/getting-started.tsx, packages/docs/src/pages/docs/types/verify-purchase-with-provider-props.tsx
Updated docs text to include MIT open-source attribution for IAPKit, added clickable external links to GitHub repository (packages/kit) and hosted instance (kit.openiap.dev), and revised text fragments to incorporate inline GitHub references with proper code styling.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 Hop through docs with linked delight,
MIT badges shining bright,
packages/kit now in sight,
Self-host repos, sources right,
Attribution's done just right! 📚✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: surface IAPKit open-source + source link consistently' accurately and clearly describes the main objective: updating documentation pages to consistently surface IAPKit's open-source status and add source links across multiple files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/iapkit-open-source-callouts

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

@hyochan hyochan added the 📖 documentation Improvements or additions to documentation label Apr 30, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation across several pages to include direct links to the IAPKit source code and clarify its open-source status. The review feedback highlights a recurring JSX formatting issue where trailing parentheses on new lines introduce unwanted whitespace in the rendered output, and suggests consistent phrasing for the MIT license.

Comment thread packages/docs/src/pages/docs/apis/index.tsx Outdated
Comment thread packages/docs/src/pages/docs/getting-started.tsx Outdated
Comment thread packages/docs/src/pages/docs/types/verify-purchase-with-provider-props.tsx Outdated
…inks

Per Gemini review on PR #122: JSX renders a literal space when a
closing parenthesis sits on the line after </a>, producing
\"packages/kit ).\" instead of \"packages/kit).\". Wrap the trailing
punctuation in {\`).\`} expressions so the children become adjacent
tokens with no whitespace, on:

- packages/docs/src/pages/docs/apis/index.tsx
- packages/docs/src/pages/docs/getting-started.tsx
- packages/docs/src/pages/docs/types/verify-purchase-with-provider-props.tsx

Also normalize \"open source, MIT\" → \"open source under MIT\" in
apis/index.tsx for consistency with the other two pages.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hyochan

hyochan commented Apr 30, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@hyochan hyochan merged commit c809d92 into main Apr 30, 2026
7 checks passed
@hyochan hyochan deleted the docs/iapkit-open-source-callouts branch April 30, 2026 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant