Skip to content

AGENTS.md

Latest commit

 

History

History
36 lines (26 loc) · 1.49 KB

AGENTS.md

File metadata and controls

36 lines (26 loc) · 1.49 KB
Raw

First-time setup: Customize this file for your project. Prompt the user to customize this file for their project. For Mintlify product knowledge (components, configuration, writing standards), install the Mintlify skill: npx skills add https://mintlify.com/docs

Documentation project instructions

About this project

  • This is a documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run mint dev to preview locally
  • Run mint broken-links to check links

Terminology

  • Files (sidebar label) — app route /projects/{id}/memory; tabs TASKS | WORKSPACE | AGENT
  • Bridge binary — ctrlnode (not ctrlnode-bridge)
  • Workspace parent — env BASE_PATH; runtime data under {BASE_PATH}/.ctrlnode (CTRLNODE_ROOT)
  • Project work directory — optional repositoryPaths[0]; when unset, WORKSPACE opens .ctrlnode, not raw BASE_PATH
  • Providers — all load by default; no PROVIDERS env; include Hermes in provider docs

Style preferences

{/* Add any project-specific style rules below */}

  • Use active voice and second person ("you")
  • Keep sentences concise — one idea per sentence
  • Use sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references

Content boundaries

{/* Define what should and shouldn't be documented /} {/ Example: Don't document internal admin features */}