Documentation project instructions
About this project
- This is the Tilde Enterprise documentation site, built on Mintlify.
- Pages are MDX files with YAML frontmatter. Configuration lives in
docs.json. - Run
mint devto preview locally, andmint broken-linksto check links. - The Mintlify writing skill is in
.agents/skills/mintlify-docs.
Terminology
- The product is Tilde Enterprise. The platform is Tilde.
- Use gateway for the Tilde container, sidecar for
tilde-sidecar, and agent for customer code. - Use Agent Registry, connection, deployment, session, run, and invocation consistently. A session is a conversation thread.
- Use envelope encryption key (EEK) and data encryption key (DEK).
- Use security middleware for the feature, and guard for one detector.
- Write on-prem for customer-controlled infrastructure. Tilde hosts nothing.
Style preferences
- Use active voice and second person (“you”).
- Keep sentences concise, with one idea per sentence.
- Use sentence case for headings.
- Bold UI elements: select Security.
- Use code formatting for file names, commands, paths, environment variables, and code references.
- Lead each page with what the feature is, before how to use it.
- Do not use marketing language, filler phrases, or emoji.
- Put
<>and{}placeholders inside code formatting. MDX parses them as JSX elsewhere.
Content boundaries
- Document behaviour that operators and agent developers rely on. Do not document internal module names or database tables.
- State security properties precisely. Do not claim certifications. Say which guidance a design follows.
- Every diagram needs a
.drawiosource inimages/beside its rendered.drawio.svg.