For agents
The docs as files a coding agent can read: an index, every page as Markdown, and each API's schema.
Everything on this site is served as plain text as well as a page, so a coding agent can read it without parsing HTML.
An index of every page
https://docs.kith.contact/llms.txt lists every page with its one-line description, each linked to the page's Markdown, and links each API's schema file. Start there.
Every page in one file
https://docs.kith.contact/llms-full.txt: the words of every page.https://docs.kith.contact/ats/llms-full.txt: the Kith ATS pages only, its overview and its whole reference.https://docs.kith.contact/sourcing/llms-full.txt: the Kith Sourcing pages only.
Any page as Markdown
Add .md to a page's address:
| Page | Markdown |
|---|---|
/ | /index.md |
/ats | /ats.md |
/ats/reference/objects/job | /ats/reference/objects/job.md |
/sourcing/reference/queries/searches | /sourcing/reference/queries/searches.md |
Or ask for the page itself with Accept: text/markdown:
curl -H "Accept: text/markdown" https://docs.kith.contact/atsEach page's HTML also names its Markdown, in a <link rel="alternate" type="text/markdown"> in its head.
Each API's schema
The schema is the contract. Each file is GraphQL SDL, with every description the reference shows:
- Kith ATS schema:
https://docs.kith.contact/schemas/ats.graphql - Kith Sourcing schema:
https://docs.kith.contact/schemas/sourcing.graphql
Give a schema file to a code generator, or read it whole: it is the fastest way to learn what an API has.
Reference pages have stable addresses
A reference page's address is its group and its name: /ats/reference/queries/jobs, /ats/reference/objects/job-candidate, /sourcing/reference/enums/search-status. Each API's reference starts with a list of all of its pages: Kith ATS, Kith Sourcing.
Working from these docs
- Use only what a schema declares. Both APIs are being built domain by domain: an operation, field or argument that is not in the schema does not exist yet.
- Take each API's endpoint from its overview: Kith ATS, Kith Sourcing.
- The two APIs are separate. A type with the same name in both, such as
WorkspaceorViewer, is not the same type.