6 Commits
Author SHA1 Message Date
tazlin 0822891e84 docs: wording, structure, and chat accuracy
Broad editorial pass over docs/ plus a nav update in zensical.toml.

- Wording and style: replace "carries"/"answers" phrasing with plainer terms, use periods instead of semicolons, and split long paragraphs.
- Structure: add subheadings and tables in the chat, moderation, kudos, model reference and style contract docs. Add "Code map" and "Contract tests" sections to several reference pages. Move the code maps in chat_front.md and chat_requests.md to the end of those pages. Reorder the minimal chat worker page so the procedure comes before the source listing.
- Content fixes:
  - Document the 404 ChatJobAborted vs ChatProgressNotStreaming progress responses.
  - Document the availability refusal table (503/404/400).
  - Document fail-fast admission and queue-position refresh.
  - Fix the stream parser example to check response.ok and error on a missing [DONE].
  - Fix the style contract's max_length ceiling (16384).
  - Note that the kudos heartbeat metrics are quorum-node only.
  - Clarify tool_choice, strict conformance and capability caveats in the tutorial.
- Navigation: reorder Tutorial and Topics in the docs landing page and zensical nav. Exclude /openai-chat-local/ from builds.
- Chat doc summaries were rewritten in several front matter blocks and the generated README tables updated to match.
2026-11-02 20:38:38 -05:00
tazlin 9453d62052 docs(chat): tutorials, how-tos and explanation for chat integrators
- Two tutorials open `docs/tutorial/`: a client's first chat completion with the OpenAI SDK (model choice, completion, stream, tool round, `json_schema` reply) and a worker's first chat job with koboldcpp (declaration, registration, a chat and a tool request on the native route)
- How-tos for sending chat completions from an OpenAI client, adding chat to a web frontend and serving chat jobs from a text worker
- `docs/explanation/chat_requests.md` covers the template problem, each design choice with its decision record and the rejected alternative, and what a client can and cannot rely on
- `chat` joins the topic vocabulary; the navigation lists the tutorial class, the pages and the chat front and outbound requests references; indexes regenerated
2026-10-30 23:46:04 -04:00
tazlin d3d5d67c77 docs: image frontend how-to guide
Adds a new how-to document covering integration of modern image controls (sampler discovery, schedules, solver controls, expanded ControlNet types, and annotation) into an existing frontend. Also updates the samplers/schedulers reference with formatting fixes and registers the new doc in the nav and topic index.
2026-08-19 14:02:10 -04:00
tazlin 3227ba2af9 docs: new docs editing for tone 2026-07-28 13:23:45 -04:00
tazlin 60943a1346 docs/refactor: restructure docs indexes and section overviews
- Reworked the service docs landing pages to emphasize the documentation classes and topic-based navigation, and added generated overview indexes for Explanation, Reference, and How-to sections.
- Added front matter and generated topic links to kudos docs so they can be indexed consistently, updated the decisions intro text, and documented index regeneration requirements in CONTRIBUTING.
- Updated zensical navigation to include Topics and section Overview pages, plus stub-status tooltip support for planned documents.
2026-07-28 13:23:45 -04:00
tazlin 01e769de0f docs: kudos accounting Diataxis set and haidra-assets submodule
- add docs/explanation/kudos_accounting.md (design rationale and guarantees), docs/reference/kudos_accounting.md (maintainer contract: schemas, producer/consumer inventories, lock order, review checklist), and docs/how-to/kudos_ledger_operations.md (cutover, rollback, recovery procedure)
- add docs/README.md index and link it from the repository README
- add the haidra-assets submodule for shared user-facing kudos documentation
2026-07-28 13:23:45 -04:00