Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.24 KB

File metadata and controls

37 lines (28 loc) · 2.24 KB

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 the documentation site for Otter Shell on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Source reference code lives at /home/ferreo/otter-shell (each component is an independent git repo)
  • Use the Mintlify MCP server, https://mcp.mintlify.com, to edit content and settings via MCP

Terminology

  • Use Otter Shell for the desktop environment (not "Otter" alone in headings)
  • Use pikman for end-user installation (pikman install otter-shell), not apt install
  • otter-shell is the base metapackage; otter-shell-extras adds otter-transcribe, otter-vox, Otter Assistant (otter-assist, otter-assistant, otter-assist-data), and model packages (otter-assist-model, otter-transcribe-model, otter-vox-model)
  • otter-gaming-utils is a separate metapackage (not in otter-shell) for Otter Bench / Otter HUD; packaging repo is otter-gaming-utils
  • Otter Shell does not ship a compositor. Do not document River or any compositor as the default.
  • The greeter (otter-greeter) uses Hyprland for the login screen only. User sessions use their own compositor.
  • otter-cue may appear in zenith pins for library work. Do not document it as a packaged end-user app unless debian/control lists it.

Style preferences

  • 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
  • Base documentation on component READMEs in the otter-shell source. Do not invent features or package contents.

Content boundaries

  • Document packaged components only unless marked as workspace-only (otter-hypr, otter-cue when not in debian/control)
  • Do not claim packages are in metapackages when debian/control says otherwise
  • Developer docs belong in the Developer Guide tab