docs: Update readme, enable Knit (#162) (#510)

#162 

## Motivation and Context
- update readme
- add more snippets 
- add knit

## How Has This Been Tested?
knit on CI

## Breaking Changes
None

## 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)
- [x] Documentation update

## Checklist
- [x] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [x] My code follows the repository's style guidelines
- [x] New and existing tests pass locally
- [ ] I have added appropriate error handling
- [x] I have added or updated documentation as needed

---------

Co-authored-by: devcrocod <devcrocod@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Konstantin Pavlov 2026-02-06 18:40:31 +02:00 • committed by GitHub
commit adc4150f1f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

35
docs/build.gradle.kts Normal file
View file

@ -0,0 +1,35 @@
plugins {
kotlin("jvm")
alias(libs.plugins.knit)
}
dependencies {
implementation(project(":kotlin-sdk"))
implementation(libs.ktor.server.cio)
}
tasks.matching {
it.name == "ktlintMainSourceSetCheck" || it.name == "ktlintMainSourceSetFormat"
}.configureEach {
enabled = false
}
knit {
rootDir = project.rootDir
files = files(project.rootDir.resolve("README.md"))
defaultLineSeparator = "\n"
siteRoot = "" // Disable site root validation
}
// Only run knitCheck when explicitly requested, not as part of build/check
tasks.named("knitCheck") {
onlyIf {
gradle.startParameter.taskNames.any {
it.contains("knitCheck") || it.contains("knit")
}
}
}
tasks.clean {
delete("src")
}