Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,17 @@ We generate API reference pages from the YAML files in the spec/ folder. There a
## Behavioral rules

**Apply the style guide automatically.** Every document produced follows [docs-style-guide.md](docs-style-guide.md): content type, structure, writing principles, content elements, and AI-readability standards. Do not wait to be asked. If source material conflicts with the style guide, flag it and apply the correct standard.

**Check terminology.** Verify every product name, API name, model name, and technical term against terminology.md. Flag deviations in source material before producing output.

**Verify product claims.** Check all statements about Speechmatics products, APIs, and models against product-architecture.md. Do not reproduce claims that conflict with it.

**Atlassian (Confluence and Jira).** Use the Atlassian connection only when the project files do not cover the question, or when a contributor explicitly requests it. When used, always state that the information comes from Confluence or Jira and may be outdated or incorrect. Never present it as authoritative. Project files always take precedence over Atlassian content.

**Default mode — planning.** When given partial input, before writing:1. Identify the Diátaxis content type.2. Propose a structure: title, H2 sections, approximate scope.3. Flag any terminology or style guide issues in the source material.4. Ask for confirmation before proceeding.

**Auto mode.** If the contributor says "just write it", "go ahead", or provides a detailed structured brief, skip planning and produce the document directly.

**Word count discipline.** Produce the minimum words the reader needs to act. Before presenting any output, remove: (1) sentences that restate a heading, (2) sentences that explain a self-evident example, (3) summary or closing lines that recap what was just said.

**Flag violations.** Flag structural problems, wrong content types, terminology errors, and style guide violations. State the issue once clearly, then proceed with the contributor's preference if they choose to override.
13 changes: 13 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,19 @@ const config: Config = {
id: "Cookiebot",
"data-cbid": "d687cfe6-4b5a-43ff-8e0e-ae6a3a33aeee",
},
{
src: "https://widget.kapa.ai/kapa-widget.bundle.js",
"data-website-id": "9d6b9fcb-ce70-4c31-a262-4c7bd548bbca",
"data-project-name": "Speechmatics",
"data-project-color": "#00a2c7",
"data-project-logo": "/img/logo.svg",
"data-color-scheme-selector": "[data-theme='dark']",
"data-view-mode": "sidebar",
"data-modal-title": "Speechmatics Docs Agent",
"data-mcp-enabled": "true",
"data-mcp-server-url": "https://speechmatics.mcp.kapa.ai",
async: true,
},
],
stylesheets: [
{
Expand Down
5 changes: 4 additions & 1 deletion src/css/infima-overrides.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*
/*
You can override the default Infima variables here.
Here we're intentionally setting the same tokens for light and dark mode, since Radix handles this automatically.
*/
Expand Down Expand Up @@ -113,6 +113,9 @@ html[data-theme="dark"] {
--ifm-alert-color: var(--cyan-10);
--ifm-alert-border-color: var(--cyan-10);

--default-font-family: "DM Sans", sans-serif;
--ifm-font-family-base: var(--default-font-family);

--docusaurus-highlighted-code-line-bg: var(--gray-4);
--docusaurus-details-decoration-color: var(--gray-11);
}
Expand Down
4 changes: 2 additions & 2 deletions static/img/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.