Skip to content

Register the repo with Context7 for documentation retrieval #893

Description

@vinishjail97

Feature Request / Improvement

Register the repository with Context7 so assistants can retrieve current XTable documentation instead of relying on stale training data.

apache/hudi does this with a two-line file at their repository root:

{
  "url": "https://context7.com/apache/hudi",
  "public_key": "..."
}

Why

XTable's configuration surface and format support change every release. Answers people get from assistants today are drawn from whatever was in training data, which means old config keys and formats we no longer recommend. Doc retrieval fixes that without any code.

Scope

  • Add a context7.json at the repository root, pointing at an XTable entry.
  • Confirm there is nothing in it that conflicts with ASF policy, since it references a third-party service and carries a public key.
  • Check whether the file needs an ASF license header, or an exclusion in the RAT configuration if the format does not permit comments.

Small and independent of the rest of this umbrella. Reasonable as a first contribution.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions