Skip to content

chore(docs): add context7.json so Context7 indexes user docs, not maintainer docs - #63

Closed
onamfc wants to merge 2 commits into
mainfrom
chore/context7-config
Closed

onamfc wants to merge 2 commits into
mainfrom
chore/context7-config

Conversation

@onamfc

@onamfc onamfc commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Description

The package is indexed on Context7, which AI editors query for up-to-date library docs. Context7 reads every markdown file in a repository, so today's index includes the contributing guide, the CLA, the publishing guide and the Docker Hub description alongside the real docs. One of its snippets for this library is "Commit message examples".

This adds a context7.json at the repo root (Context7's equivalent of robots.txt) that:

  • excludes maintainer-only files (CONTRIBUTING.md, CLA.md, PUBLISHING.md, DOCKERHUB.md, CHANGELOG.md) and the .github, src, migrations, signatures and coverage folders
  • keeps the README, DOCKER.md, SDK_SPEC.md, llms.txt, examples/ and the infra/ deployment guides
  • sets the title and description shown on the library page
  • adds four short rules an assistant should know before writing code against the package (no built-in auth, runtime requirements, immutable short codes, where the hosted docs are)

Type of Change

  • 📝 Documentation update

Changes Made

  • Add context7.json

Testing

Config only; no runtime code touched. The JSON parses and follows the published schema at https://context7.com/schema/context7.json.

Follow-up (not in this PR)

The file also carries the url and public_key fields from the Context7 claim flow, so once this is on main, finishing the claim at context7.com/linkforty/core/admin verifies ownership and unlocks the admin panel. Trigger a refresh there so the new config takes effect.

Breaking Changes

None

…ntainer docs

Context7 indexes every markdown file in the repository. Without a config
that includes the contributing guide, the CLA, the publishing guide and
the Docker Hub description, so a developer asking an AI editor how to
create a link can be handed a commit-message convention instead.

This narrows the index to the README, the Docker and SDK guides, the
examples and the infra deployment guides, sets the title and description
shown on the library page, and adds a few short rules an assistant
should know before writing code against the package.
@codecov

codecov Bot commented Oct 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Context7 verifies ownership by fetching this file from the default
branch and matching the url and public_key fields, which unlocks the
admin panel (manual refresh, versions, benchmark) for the library.
@onamfc

onamfc commented Oct 2, 2026

Copy link
Copy Markdown
Member Author

Closing: not integrating Context7 config into the repo at this time.

@onamfc onamfc closed this Oct 2, 2026
@onamfc
onamfc deleted the chore/context7-config branch October 2, 2026 01:49
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 2, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant