Skip to content

Add context7 repository indexing#100

Merged
venables merged 3 commits into
agentcommercekit:mainfrom
EfeDurmaz16:docs/agent-framework-indexing
Jun 4, 2026
Merged

Add context7 repository indexing#100
venables merged 3 commits into
agentcommercekit:mainfrom
EfeDurmaz16:docs/agent-framework-indexing

Conversation

@EfeDurmaz16
Copy link
Copy Markdown
Contributor

@EfeDurmaz16 EfeDurmaz16 commented May 16, 2026

Summary

  • add a Context7 configuration for indexing ACK docs, packages, and demos
  • document the intended agent-framework adapter boundary
  • add cookbook targets for OpenAI Agents SDK, Claude Agent SDK, Vercel AI SDK, and MCP examples

Closes #98

Verification

  • pnpm exec oxfmt --check context7.json docs/docs.json docs/overview/agent-framework-integrations.mdx
  • node -e "const fs=require('fs'); for (const f of ['context7.json','docs/docs.json']) JSON.parse(fs.readFileSync(f,'utf8')); console.log('json ok')"
  • test -f docs/overview/agent-framework-integrations.mdx
  • git diff --check

Notes

  • Context7 documents repository configuration through a root context7.json; this PR keeps runtime framework adapters as follow-up work.

AI Usage Disclosure

This contribution was AI-assisted using Codex CLI and the Codex app. AI assistance was used for repository/docs navigation, understanding ACK/Catena context, identifying relevant issues or contribution areas, and assisting with small edits/validation. I reviewed the final diff and take responsibility for the submitted changes.

Summary by CodeRabbit

  • Chores
    • Added project configuration with metadata, folder management settings, and integration guidelines.

Signed-off-by: EfeDurmaz16 <efebarandurmaz05@gmail.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e7c4ac06-027b-4f3a-8102-5d3add1637d9

📥 Commits

Reviewing files that changed from the base of the PR and between 6f65936 and e678499.

📒 Files selected for processing (1)
  • context7.json

Walkthrough

A new context7.json configuration file is added to enable Context7-based indexing of ACK documentation and codebase. The file declares the Context7 schema, includes project metadata (title and description), defines folder and file inclusion/exclusion rules, and provides three protocol rules guiding the use of ACK-ID and ACK-Pay primitives with emphasis on keeping framework integrations thin.

Changes

Context7 Indexing Configuration

Layer / File(s) Summary
Context7 configuration and metadata
context7.json
New context7.json defines Context7 schema, project metadata (title/description), folder/file inclusion and exclusion configuration, and three protocol rules describing ACK-ID and ACK-Pay usage patterns and framework integration guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add context7 repository indexing' accurately describes the main change—adding a context7.json configuration file for repository indexing, which is the primary deliverable in this PR.
Linked Issues check ✅ Passed The PR adds the context7.json configuration for repository indexing as required by issue #98, fulfilling the primary objective of making ACK documentation indexable by Context7.
Out of Scope Changes check ✅ Passed The PR contains only the context7.json file addition, which is directly aligned with the linked issue #98 objectives for Context7 indexing configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ 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 and usage tips.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 351a79d89c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

library identity is:

```text
agentcommercekit/ack
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Include the leading slash in the Context7 ID

When readers copy this as the exact Context7 library identity for MCP/API usage, it does not match Context7's documented ID format: their API guide defines a library ID as the URL path and says to use /owner/repo for GitHub repositories (for example /vercel/next.js). The guide should show /agentcommercekit/ack so users can paste it directly into use library ..., refresh, or docs queries without first re-resolving the library.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 3ef8133 by using the canonical /agentcommercekit/ack Context7 library ID.

EfeDurmaz16 and others added 2 commits May 16, 2026 07:52
Signed-off-by: EfeDurmaz16 <efebarandurmaz05@gmail.com>
Remove the agent-framework-integrations doc page and its nav entry;
keep only the context7.json repository indexing config.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@venables venables changed the title docs: add agent framework indexing guide Add context7 repository indexing Jun 4, 2026
@venables
Copy link
Copy Markdown
Contributor

venables commented Jun 4, 2026

Thanks for the contribution, @EfeDurmaz16 — and congrats on your first one merged into ACK! 🎉

I trimmed this PR down a bit before merging: I dropped the docs/overview/agent-framework-integrations.mdx page and its nav entry, since that content is somewhat incompatible with our published docs as-is (the framing around "maintainers or contributors" reads a little oddly in the public docs context). I kept the context7.json repository indexing config, which is a clean, self-contained win on its own.

Appreciate you getting the Context7 indexing set up for us!

Copy link
Copy Markdown
Contributor

@venables venables left a comment

Choose a reason for hiding this comment

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

LGTM — clean, self-contained Context7 indexing config. Thanks again!

@venables venables merged commit 81573a7 into agentcommercekit:main Jun 4, 2026
1 check was pending
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.

docs: add agent framework integration and Context7 indexing guidance

2 participants