diff --git a/best-practices/overview.mdx b/best-practices/overview.mdx new file mode 100644 index 0000000..d4ab8b3 --- /dev/null +++ b/best-practices/overview.mdx @@ -0,0 +1,111 @@ +--- +title: 'Best Practices Overview' +description: 'Follow these guidelines to create effective documentation with Astrio' +--- + +## Overview + +Follow these guidelines to create effective documentation with Astrio. These best practices will help you build better applications faster. + + + + Keep files concise and focused with clear organization + + + Write for your audience with practical examples + + + Update regularly and gather user feedback + + + Leverage Astrio's visual editor and collaboration features + + + +## Structure + + + + Focus on one topic per file for better organization + + + Structure content with descriptive, hierarchical headings + + + Group related content and maintain consistent flow + + + +## Content + + + + Consider who will read and use your documentation + + + Provide practical, real-world examples to illustrate concepts + + + Use clear, direct language that's easy to understand + + + +## Maintenance + + + + Keep documentation current with your application changes + + + Verify that instructions work as described + + + Listen to users and improve based on their needs + + + +## Tools + + + + Make quick updates with Astrio's visual editor + + + Work together with your team in real-time + + + Use your own domain for professional branding + + + + +Following these best practices will help you create documentation that's both useful and maintainable. Start with the basics and refine as you learn what works best for your team. + diff --git a/best-practices/prompt-efficiency.mdx b/best-practices/prompt-efficiency.mdx new file mode 100644 index 0000000..9117da3 --- /dev/null +++ b/best-practices/prompt-efficiency.mdx @@ -0,0 +1,144 @@ +--- +title: 'Prompt Efficiency' +description: 'Optimize your prompts for better results with Astrio' +--- + +## Overview + +Optimize your prompts for better results with Astrio. Well-crafted prompts lead to faster development and higher quality applications. + + + + Be specific and action-oriented in your requests + + + Organize your prompts for maximum clarity + + + Learn from good and bad prompt examples + + + Start simple and refine your approach + + + +## Clear Instructions + + + + Clearly state what you want to achieve + + + Start with verbs like "create," "build," "design" + + + Provide relevant background information when needed + + + +## Structure + + + + Lead with your primary goal or requirement + + + Include specifications, constraints, and preferences + + + Describe what success looks like + + + +## Examples + +### Good Prompts + + + + "Create a user guide for the login feature with screenshots" + + + "Build a landing page for a bakery with warm colors and mobile-first design" + + + +### Poor Prompts + + + + "Make something about login" + + + "Create a website" + + + +## Iteration + + + + Begin with basic requirements, then add complexity + + + Experiment with various prompt styles and structures + + + Analyze what works and refine your technique + + + +## Tips + + + + Break down complex requests into clear, scannable lists + + + Mention your preferred output format and style + + + Consider who will use or view the final result + + + + +Remember: The more specific and clear your prompt, the better the results. Don't be afraid to iterate and refine your approach based on what works best for your projects. + diff --git a/best-practices/token-efficiency.mdx b/best-practices/token-efficiency.mdx new file mode 100644 index 0000000..7b1ef51 --- /dev/null +++ b/best-practices/token-efficiency.mdx @@ -0,0 +1,166 @@ +--- +title: 'Token Efficiency' +description: 'Maximize your token usage for better performance and cost-effectiveness' +--- + +## Overview + +Maximize your token usage for better performance and cost-effectiveness. Understanding tokens and optimizing your project structure can significantly improve your Astrio experience. + + + + Learn how tokens work and impact processing + + + Exclude unnecessary files to reduce token consumption + + + Break large projects into focused sections + + + Follow proven strategies for token optimization + + + +## Understanding Tokens + + + + Tokens are units of text processing used by AI models + + + Shorter content = fewer tokens = faster processing + + + Focus on essential information rather than verbose descriptions + + + +## Using .astrio/ignore + +Create a `.astrio/ignore` file to exclude unnecessary files from processing: + +```bash +node_modules/ +.git/ +*.log +temp/ +build/ +dist/ +.env +.DS_Store +``` + + + + Skip irrelevant content during processing + + + Faster analysis and generation times + + + +## Project Splitting + +Break large projects into smaller, focused sections for better token efficiency: + + + + Create dedicated files for specific functionality + + + Follow consistent file naming conventions + + + Organize files by topic or purpose + + + +### Example Structure + +``` +project/ +├── components/ +│ ├── header.mdx +│ ├── footer.mdx +│ └── navigation.mdx +├── features/ +│ ├── authentication.mdx +│ ├── dashboard.mdx +│ └── settings.mdx +└── guides/ + ├── getting-started.mdx + └── advanced-usage.mdx +``` + +## Best Practices + + + + Eliminate duplicate or unnecessary content + + + Write clearly and directly without fluff + + + Prioritize important information + + + Periodically review and remove outdated files + + + +## Token Optimization Checklist + + + + Organize content logically and eliminate duplicates + + + Exclude unnecessary files and directories + + + Break down lengthy documents into focused sections + + + Remove redundant information and use concise language + + + + +Token efficiency isn't just about saving costs—it's about getting faster, more focused results. Start with these practices and refine your approach based on your specific project needs. + diff --git a/introduction/welcome.mdx b/introduction/welcome.mdx index bbba61b..3f7861c 100644 --- a/introduction/welcome.mdx +++ b/introduction/welcome.mdx @@ -44,7 +44,7 @@ Astrio is a powerful platform that transforms your ideas into fully functional a Optimize your Astrio applications diff --git a/mint.json b/mint.json index 5ef2b9f..2b4112e 100644 --- a/mint.json +++ b/mint.json @@ -37,7 +37,11 @@ { "name": "Integrations", "url": "integrations" - } + }, + { + "name": "Best Practices", + "url": "best-practices" + } ], "anchors": [ { @@ -85,6 +89,14 @@ "integrations/payments", "integrations/third-parties" ] + }, + { + "group": "Best Practices", + "pages": [ + "best-practices/overview", + "best-practices/prompt-efficiency", + "best-practices/token-efficiency" + ] } ], "feedback": {