Frontend Api Doc
No description available
Install / Use
/learn @phonely-ai/Frontend Api DocREADME
Phonely Documentation
This directory contains the Mintlify docs for the Phonely frontend product and the API-key-authenticated frontend API surface.
Local Preview
Prerequisites:
- Node.js 18 or newer
Install the Mintlify CLI:
npm i -g mint
Start the local preview from this directory:
mint dev
Optional custom port:
mint dev --port 3333
Important Files
docs.json: navigation, theme, indexing, contextual AI integrations.mintlify/Assistant.md: Mintlify assistant instructionsllms.txt: compact LLM entrypointskill.md: Phonely-specific agent rulesai/*.mdx: hidden indexed runbooks for agent retrieval
Documentation Scope
This docs set covers:
- Phonely frontend routes and task flows
- public product behavior
- frontend and API-key-authenticated endpoints documented under
api-reference
Authoring Rules
- Keep visible docs human-friendly and product-accurate.
- Use hidden
ai/*.mdxpages for stricter agent runbooks. - Keep one canonical page per concept.
- Add
titleanddescriptionto every indexed MDX page. - Use
.mintignoreornoindex: truefor legacy, duplicate, or out-of-scope pages. - Keep hidden AI runbooks public-safe. Hidden does not mean secret.
