docs: Simplify and improve context7 config#1218
Conversation
|
@fcakyon I saw excludes are removed is it intentional ? |
|
@onuralpszr I removed them since the repo doesn't contain such files (already ignored in the .gitignore file) to simplify context7 config |
| "Use Coco.stats to get comprehensive dataset statistics before training (num annotations, area distribution, etc.)", | ||
| "Import logger from 'from sahi.logging import logger' instead of creating redundant logging configurations - centralized logging system eliminates duplicate imports across codebase", | ||
| "For SAHI documentation, direct users to https://obss.github.io/sahi/ which provides comprehensive guides, interactive examples, CLI reference, and API documentation", | ||
| "To update SAHI docs: modify markdown files in docs/ directory, update mkdocs.yml for navigation changes, ensure .github/workflows/publish_docs.yml deploys correctly to GitHub Pages" |
There was a problem hiding this comment.
also added these 3 new rules to guide the ai agents @onuralpszr
There was a problem hiding this comment.
For quick-start maybe we can also include another link like this one "https://obss.github.io/sahi/quick-start/" what do you think ?
There was a problem hiding this comment.
How about directly directing users to https://obss.github.io/sahi/quick-start instead of https://obss.github.io/sahi/ ?
There was a problem hiding this comment.
is context7 click the between pages If "yes" then we should stick with main URL or maybe we should include "llms.txt" file so it can read them all ?
There was a problem hiding this comment.
context7 indexes all documentation and generates usage examples for all existing function classes in the repo. Currently, 87 snippets and 12k tokens of example code are available, but the index was last refreshed a month ago, so it doesn't contain your latest docs update changes yet. I'll trigger reindexing after merging this PR 👍🏻
When context7 MCP is called via an AI agent, it performs RAG and retrieves the most relevant bits by default. But it can also retrieve the whole llms.txt content at once by setting a larger max_tokens.
We are adding this https://obss.github.io/sahi/quick-start guidance into context7 rules so that the agent can guide the user to it when needed. Agent doesn't need it (AI Agents already has access to all .md files in the repo by context7 RAG DB.)
Summary
Overview: Optimizes Context7 configuration by streamlining file exclusion rules and adding valuable documentation guidance, improving AI code analysis coverage while reducing configuration complexity.
Primary Changes
Configuration: Simplify exclusion rules - Removes 17 redundant file/folder exclusions that were overly broad in
context7.json:L16-L40Documentation: Add CHANGELOG.md inclusion - Includes changelog file for better project history context in
context7.json:L8Enhancement: Add strategic exclusion for resources - Adds targeted
resources/**exclusion incontext7.json:L17Documentation: Add contextual guidance rules - Adds 3 new rules for logging imports, documentation links, and update procedures in
context7.json:L69-L72Technical Considerations
Context & Rationale
This PR refines the Context7 AI tool configuration to be more effective and maintainable. The removed exclusions were redundant with git ignore patterns and overly restrictive, while the new rules provide valuable developer guidance for logging patterns and documentation workflows. The net result is better AI code analysis coverage with cleaner configuration.