1.4 KiB
1.4 KiB
AI Documentation Project
This repo contains the source markdown for a Confluence-ready AI documentation set for mobile development. It is designed to be beginner-friendly and easy to keep current.
Audience
These docs assume the reader is new to AI. Be explicit, explain terms, and include examples where possible.
Structure
How to Use
- Start at the AI Docs Index.
- Follow the iOS or Android setup guide.
- Review skills and token usage guidance.
Local Workflow
- Edit files in docs/ai.
- Keep sections short and scannable.
- Avoid vendor-specific step details that change frequently.
- Keep Agents, PRD, and README in sync when scope or structure changes.
Publish to Confluence
- Copy the page content from each markdown file.
- Preserve the hierarchy shown in docs/ai/index.md.
- Add screenshots or short videos where helpful.
Contributing
- Keep content short, direct, and beginner-friendly.
- Add platform-specific examples when possible.
- Update the Skills Library with repo links.
Example Change
"Add a new skill link to docs/ai/skills.md and include a 2-sentence description."
Next Steps
- Add screenshots and short walkthrough videos.
- Assign owners per section.
- Publish to Confluence.