Skip to main content

Neurobro Docs - Claude instructions

This repository is the Neurobro documentation site, built with Mintlify (docs.json is the nav/config; pages are .mdx).

Content style - hard rules

  • Never use em dashes or en dashes (the long dashes, U+2014 / U+2013) in any content. Always use - (space, hyphen, space) instead. This applies to every .mdx page, its frontmatter, docs.json, and any user-facing text. No exceptions.

Design system - subscription tiers

  • Pro is always silver; Ultra is always gold - per the Neurobro mobile design system (neurobro-terminal-mobile, lib/core/theme/app_theme_colors.dart). Use these hex values:
    • Pro (silver): #94ACC4 (dark) / #4A6278 (light)
    • Ultra (gold): #D4A537 (dark) / #C49500 (light)
  • On the dark-default docs, use the dark values (#94ACC4, #D4A537) - e.g. the color prop on tier <Card>s. Pro uses a hexagon icon, Ultra a gem icon (matching mobile).
  • Basic is neutral, never red - use a grey such as #94A3B8 for its icon.
  • Tier benefit checkmarks are neutral grey (#83838B, textSecondary), matching mobile’s default - the accent colour only appears on the currently-selected tier. Colour the tier icon, not the checks.

Workflow

  • After editing content, run mint broken-links and make sure it passes before committing.
  • Keep legal pages (legal/*.mdx) changes isolated in their own commit, separate from other docs changes.