mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-04 10:52:13 +02:00
docs: standardize ktx naming
This commit is contained in:
parent
27afd6a3b0
commit
1f8c1089f6
41 changed files with 331 additions and 313 deletions
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: Contributing
|
||||
description: Contribute to KTX through code, docs, connectors, and examples.
|
||||
description: Contribute to ktx through code, docs, connectors, and examples.
|
||||
---
|
||||
|
||||
KTX is an open-source context layer for data agents. The project welcomes
|
||||
**ktx** is an open-source context layer for data agents. The project welcomes
|
||||
focused contributions that improve setup, integrations, CLI behavior,
|
||||
documentation, connector coverage, and examples.
|
||||
|
||||
|
|
@ -25,12 +25,12 @@ documentation, connector coverage, and examples.
|
|||
| Context engine | `packages/context`, including project config, ingest orchestration, and semantic search |
|
||||
| Connectors | `packages/connector-*`, plus connector-specific tests and integration docs |
|
||||
| Python semantic layer | `python/ktx-sl` for planning and SQL compilation |
|
||||
| KTX daemon | `python/ktx-daemon` for the portable runtime API |
|
||||
| **ktx** daemon | `python/ktx-daemon` for the portable runtime API |
|
||||
| Documentation | `docs-site/content/docs` for public docs and `docs-site/tests` for docs behavior |
|
||||
|
||||
## Development setup
|
||||
|
||||
This page is for contributors working on the KTX repository. To install KTX for
|
||||
This page is for contributors working on the **ktx** repository. To install **ktx** for
|
||||
an analytics project, use the published
|
||||
[`@kaelio/ktx`](https://www.npmjs.com/package/@kaelio/ktx) package in the
|
||||
[Quickstart](/docs/getting-started/quickstart).
|
||||
|
|
@ -80,7 +80,7 @@ changes.
|
|||
|
||||
## Repository structure
|
||||
|
||||
KTX is a pnpm + uv workspace. TypeScript packages live in `packages/`, Python
|
||||
**ktx** is a pnpm + uv workspace. TypeScript packages live in `packages/`, Python
|
||||
projects in `python/`.
|
||||
|
||||
```text
|
||||
|
|
@ -264,8 +264,8 @@ approach.
|
|||
|
||||
## Agent usage notes
|
||||
|
||||
Use this page when an agent is modifying the KTX repository itself rather than
|
||||
using KTX in an analytics project.
|
||||
Use this page when an agent is modifying the **ktx** repository itself rather than
|
||||
using **ktx** in an analytics project.
|
||||
|
||||
| Agent task | Command or section |
|
||||
|------------|--------------------|
|
||||
|
|
|
|||
|
|
@ -1,26 +1,26 @@
|
|||
---
|
||||
title: Community & Support
|
||||
description: Join the KTX Slack community, report bugs, and get help.
|
||||
description: Join the ktx Slack community, report bugs, and get help.
|
||||
---
|
||||
|
||||
KTX is an open-source project. The community is where users, contributors, and
|
||||
**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) |
|
||||
| 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
|
||||
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)
|
||||
[**Join the ktx Slack →**](https://join.slack.com/t/ktxcommunity/shared_invite/zt-3y9b44m1x-LVyNNJD5nwaZHq4XS29LMQ)
|
||||
|
||||
Slack is the right place for:
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ searchable, get triaged, and stay attached to the eventual fix.
|
|||
|
||||
## Code of conduct
|
||||
|
||||
KTX follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/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`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue