mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-28 08:49:38 +02:00
docs: add Slack community invite to README and docs
Adds a Slack badge and Community section to the README, a new Community & Support page under docs-site/content/docs/community/, and a Community section on the docs introduction page. Routes chat/questions to Slack and bugs/features to GitHub Issues. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
590dd5dddb
commit
f400fd1807
4 changed files with 68 additions and 1 deletions
11
README.md
11
README.md
|
|
@ -11,6 +11,7 @@
|
||||||
<a href="https://codecov.io/gh/Kaelio/ktx"><img src="https://codecov.io/gh/Kaelio/ktx/graph/badge.svg?branch=main" alt="Codecov" /></a>
|
<a href="https://codecov.io/gh/Kaelio/ktx"><img src="https://codecov.io/gh/Kaelio/ktx/graph/badge.svg?branch=main" alt="Codecov" /></a>
|
||||||
<a href="https://github.com/Kaelio/ktx/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/Kaelio/ktx/ci.yml?branch=main&label=tests&style=flat-square" alt="Tests" /></a>
|
<a href="https://github.com/Kaelio/ktx/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/Kaelio/ktx/ci.yml?branch=main&label=tests&style=flat-square" alt="Tests" /></a>
|
||||||
<a href="https://docs.kaelio.com/ktx/docs/"><img src="https://img.shields.io/badge/docs-KTX-22c55e?style=flat-square" alt="Documentation" /></a>
|
<a href="https://docs.kaelio.com/ktx/docs/"><img src="https://img.shields.io/badge/docs-KTX-22c55e?style=flat-square" alt="Documentation" /></a>
|
||||||
|
<a href="https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ"><img src="https://img.shields.io/badge/slack-join%20community-4A154B?style=flat-square&logo=slack&logoColor=white" alt="Join the KTX Slack community" /></a>
|
||||||
<a href="https://github.com/Kaelio/ktx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square" alt="License" /></a>
|
<a href="https://github.com/Kaelio/ktx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square" alt="License" /></a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
@ -210,8 +211,18 @@ uv run pytest -q
|
||||||
- [Quickstart](docs-site/content/docs/getting-started/quickstart.mdx)
|
- [Quickstart](docs-site/content/docs/getting-started/quickstart.mdx)
|
||||||
- [CLI Reference](docs-site/content/docs/cli-reference/ktx.mdx)
|
- [CLI Reference](docs-site/content/docs/cli-reference/ktx.mdx)
|
||||||
- [Building Context](docs-site/content/docs/guides/building-context.mdx)
|
- [Building Context](docs-site/content/docs/guides/building-context.mdx)
|
||||||
|
- [Community & Support](docs-site/content/docs/community/support.mdx)
|
||||||
- [Contributing](docs-site/content/docs/community/contributing.mdx)
|
- [Contributing](docs-site/content/docs/community/contributing.mdx)
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
- **[Slack](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ)** — ask questions, share what you're building, and chat with maintainers and other users.
|
||||||
|
- **[GitHub Issues](https://github.com/Kaelio/ktx/issues)** — report bugs and request features.
|
||||||
|
- **[Contributing guide](docs-site/content/docs/community/contributing.mdx)** — set up the repo, run tests, and open a PR.
|
||||||
|
|
||||||
|
See [Community & Support](docs-site/content/docs/community/support.mdx) for the
|
||||||
|
full guide on where to ask what.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
KTX is licensed under the Apache License, Version 2.0. See `LICENSE`.
|
KTX is licensed under the Apache License, Version 2.0. See `LICENSE`.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"title": "Community",
|
"title": "Community",
|
||||||
"defaultOpen": true,
|
"defaultOpen": true,
|
||||||
"pages": ["contributing"]
|
"pages": ["support", "contributing"]
|
||||||
}
|
}
|
||||||
|
|
|
||||||
47
docs-site/content/docs/community/support.mdx
Normal file
47
docs-site/content/docs/community/support.mdx
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
---
|
||||||
|
title: Community & Support
|
||||||
|
description: Join the KTX Slack community, report bugs, and get help.
|
||||||
|
---
|
||||||
|
|
||||||
|
KTX is an open-source project. The community is where users, contributors, and
|
||||||
|
the core team trade questions, share patterns, and shape the roadmap.
|
||||||
|
|
||||||
|
## Where to go
|
||||||
|
|
||||||
|
| You want to... | Go here |
|
||||||
|
|----------------|---------|
|
||||||
|
| Ask a question or chat with the community | [KTX Slack](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ) |
|
||||||
|
| Report a bug or request a feature | [GitHub Issues](https://github.com/Kaelio/ktx/issues) |
|
||||||
|
| Read or contribute to the docs | [docs.kaelio.com/ktx](https://docs.kaelio.com/ktx/docs/) |
|
||||||
|
| Contribute code | [Contributing guide](/docs/community/contributing) |
|
||||||
|
|
||||||
|
## Slack
|
||||||
|
|
||||||
|
Join the KTX Slack to ask questions, share what you're building, and get help
|
||||||
|
from maintainers and other users.
|
||||||
|
|
||||||
|
[**Join the KTX Slack →**](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ)
|
||||||
|
|
||||||
|
Slack is the right place for:
|
||||||
|
|
||||||
|
- **Setup and configuration questions** that don't fit a bug report
|
||||||
|
- **Quick "how do I..."** questions
|
||||||
|
- **Sharing patterns** for prompts, semantic-layer definitions, or agent workflows
|
||||||
|
- **Feedback** on the roadmap and early features
|
||||||
|
|
||||||
|
For anything reproducible - a crash, a wrong result, an unexpected CLI error -
|
||||||
|
open a [GitHub issue](https://github.com/Kaelio/ktx/issues) instead. Issues are
|
||||||
|
searchable, get triaged, and stay attached to the eventual fix.
|
||||||
|
|
||||||
|
## GitHub
|
||||||
|
|
||||||
|
- **[Issues](https://github.com/Kaelio/ktx/issues)** - bugs and feature requests
|
||||||
|
- **[Pull requests](https://github.com/Kaelio/ktx/pulls)** - code, docs, and connector contributions
|
||||||
|
- **[Releases](https://github.com/Kaelio/ktx/releases)** - changelog and published versions
|
||||||
|
|
||||||
|
## Code of conduct
|
||||||
|
|
||||||
|
KTX follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
|
||||||
|
Be respectful, assume good intent, and keep discussion focused on the project.
|
||||||
|
Report conduct concerns to the maintainers in Slack or by email at
|
||||||
|
`support@kaelio.com`.
|
||||||
|
|
@ -95,3 +95,12 @@ best first step for users; contributor setup lives in the community docs.
|
||||||
Machine-readable docs and agent-facing setup notes.
|
Machine-readable docs and agent-facing setup notes.
|
||||||
</Card>
|
</Card>
|
||||||
</Cards>
|
</Cards>
|
||||||
|
|
||||||
|
## Community
|
||||||
|
|
||||||
|
Have questions, want to share what you're building, or chat with maintainers?
|
||||||
|
Join the [KTX Slack community](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ).
|
||||||
|
For bug reports and feature requests, open a
|
||||||
|
[GitHub issue](https://github.com/Kaelio/ktx/issues). See
|
||||||
|
[Community & Support](/docs/community/support) for the full guide on where to
|
||||||
|
ask what.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue