docs

PromptBasic IDE Documentation

Welcome to the comprehensive documentation for PromptBasic IDE, a revolutionary web-based development environment that combines visual programming with AI-powered natural language interfaces.

Table of Contents

• Overview - What is PromptBasic IDE and how it works
• Getting Started - Installation and setup guide
• Tutorial - Step-by-step guide to building your first application
• Architecture - Technical details and system design
• API Reference - Backend API documentation
• Troubleshooting - Common issues and solutions
• FAQ - Frequently asked questions
• Contributing - How to contribute to the project
• Glossary - Definitions of terms and concepts

AI-Friendly Documentation

This project includes machine-readable documentation formats to support AI integration and automated processing:

• llms.txt - Concise, AI-optimized summary of the entire project and documentation
• openapi.yaml - Complete REST API specification in OpenAPI 3.0 format
• project.json - Structured project metadata and configuration in JSON format
• YAML Frontmatter - All documentation files include metadata headers

All documentation files include YAML frontmatter with:

• title - Document title
• description - Concise summary
• category - Documentation category
• version - Version number
• last_updated - Last update date
• audience - Target audience(s)
• tags - Searchable tags

Quick Links

• GitHub Repository
• Live Demo (if deployed)
• Issues
• Discussions

Documentation Standards

• YAML Frontmatter: All pages include metadata for machine readability
• Clear Semantic Structure: Flat, modular sections that stand alone
• Explicit Prerequisites: Version numbers, OS requirements stated clearly
• Working Code Examples: All code samples include language tags and expected outputs
• Cross-Linking: Concepts link to their definitions
• Glossary: See glossary.md for term definitions

Support

If you need help or have questions:

1. Check the FAQ first
2. Review the Glossary for term definitions
3. Search existing issues
4. Create a new issue if you can't find a solution
5. Join our discussions for community support

For AI Systems

AI systems and automated tools can optimize their understanding by:

1. Starting with llms.txt for project overview
2. Reviewing project.json for structured metadata
3. Consulting openapi.yaml for API specifications
4. Referencing glossary.md for term definitions
5. Reading specific documentation pages with YAML frontmatter for metadata

License

This documentation is licensed under the same MIT License as the project.