diff --git a/README.md b/README.md index d3d55d03..5726a53f 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Codecov Tests Documentation + Join the KTX Slack community License

@@ -210,8 +211,18 @@ uv run pytest -q - [Quickstart](docs-site/content/docs/getting-started/quickstart.mdx) - [CLI Reference](docs-site/content/docs/cli-reference/ktx.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) +## 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 KTX is licensed under the Apache License, Version 2.0. See `LICENSE`. diff --git a/docs-site/app/layout.config.tsx b/docs-site/app/layout.config.tsx index ae3bf27b..93b5c45b 100644 --- a/docs-site/app/layout.config.tsx +++ b/docs-site/app/layout.config.tsx @@ -1,10 +1,29 @@ import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared"; +import { GitHubIcon } from "@/components/github-icon"; import { Logo } from "@/components/logo"; +import { SlackIcon } from "@/components/slack-icon"; export const baseOptions: BaseLayoutProps = { nav: { title: , transparentMode: "top", }, - githubUrl: "https://github.com/kaelio/ktx", + links: [ + { + type: "icon", + label: "GitHub", + icon: , + text: "GitHub", + url: "https://github.com/kaelio/ktx", + external: true, + }, + { + type: "icon", + label: "Join the KTX Slack community", + icon: , + text: "Slack", + url: "https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ", + external: true, + }, + ], }; diff --git a/docs-site/components/github-icon.tsx b/docs-site/components/github-icon.tsx new file mode 100644 index 00000000..aa3ec564 --- /dev/null +++ b/docs-site/components/github-icon.tsx @@ -0,0 +1,15 @@ +import type { SVGProps } from "react"; + +export function GitHubIcon(props: SVGProps) { + return ( + + ); +} diff --git a/docs-site/components/slack-icon.tsx b/docs-site/components/slack-icon.tsx new file mode 100644 index 00000000..2a78f581 --- /dev/null +++ b/docs-site/components/slack-icon.tsx @@ -0,0 +1,29 @@ +import type { SVGProps } from "react"; + +export function SlackIcon(props: SVGProps) { + return ( + + ); +} diff --git a/docs-site/content/docs/community/meta.json b/docs-site/content/docs/community/meta.json index 0f97320e..e181be6c 100644 --- a/docs-site/content/docs/community/meta.json +++ b/docs-site/content/docs/community/meta.json @@ -1,5 +1,5 @@ { "title": "Community", "defaultOpen": true, - "pages": ["contributing"] + "pages": ["support", "contributing"] } diff --git a/docs-site/content/docs/community/support.mdx b/docs-site/content/docs/community/support.mdx new file mode 100644 index 00000000..d53e168c --- /dev/null +++ b/docs-site/content/docs/community/support.mdx @@ -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`. diff --git a/docs-site/content/docs/getting-started/introduction.mdx b/docs-site/content/docs/getting-started/introduction.mdx index d0ee126d..2bf6e9b1 100644 --- a/docs-site/content/docs/getting-started/introduction.mdx +++ b/docs-site/content/docs/getting-started/introduction.mdx @@ -95,3 +95,12 @@ best first step for users; contributor setup lives in the community docs. Machine-readable docs and agent-facing setup notes. + +## 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.