Skip to content

docs: context7 config file#605

Merged
devcrocod merged 1 commit intomainfrom
devcrocod/context7
Mar 17, 2026
Merged

docs: context7 config file#605
devcrocod merged 1 commit intomainfrom
devcrocod/context7

Conversation

@devcrocod
Copy link
Contributor

Motivation and Context

  • removed unnecessary badges from readme
  • add context7 json file

How Has This Been Tested?

Breaking Changes

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a Context7 configuration file to the repository and adjusts README badges to better reflect what’s highlighted at the top of the project page.

Changes:

  • Add context7.json with project metadata and exclusion rules.
  • Remove Conformance + Codecov badges from the README header.
  • Move the DeepWiki badge into the “Documentation” section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
context7.json Introduces Context7 configuration, including excluded folders/files.
README.md Simplifies top-level badges and relocates DeepWiki badge to the docs section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

See the [samples overview](./samples/README.md) for a comparison table and detailed descriptions.

## Documentation
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/modelcontextprotocol/kotlin-sdk)
Copy link
Contributor

Choose a reason for hiding this comment

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

it worths moving the documentation section after the TOC

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps, though I'm not sure

For now, since we only have generated dokka documentation, it may be too early to do that. Once we add proper full documentation, it would probably make sense to place it upper

Comment on lines -5 to -6
[![Conformance Tests](https://github.com/modelcontextprotocol/kotlin-sdk/actions/workflows/conformance.yml/badge.svg)](https://github.com/modelcontextprotocol/kotlin-sdk/actions/workflows/conformance.yml)
[![codecov](https://codecov.io/github/modelcontextprotocol/kotlin-sdk/graph/badge.svg?token=O2CFHNSFYM)](https://codecov.io/github/modelcontextprotocol/kotlin-sdk)
Copy link
Contributor

Choose a reason for hiding this comment

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

We should retain the badges. They are important operational indicators.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

important operational indicators

What is the practical value of these indicators?

  • conformance test - when a baseline exists, this indicator does not always reflect the actual state of the project and can even be misleading in some cases. A badge for the main CI build is usually sufficient, adding badges for multiple CI workflows feels redundant
  • codecov - coverage numbers without context provide limited value on their own. I doubt this is genuinely useful for users or contributors. Especially since each PR already includes a coverage report, which is usually sufficient

@devcrocod devcrocod merged commit c136ad9 into main Mar 17, 2026
24 checks passed
@devcrocod devcrocod deleted the devcrocod/context7 branch March 17, 2026 23:34
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.

5 participants