diff --git a/docs/content/guides/6.best-practices/3.ai-contexts.md b/docs/content/guides/6.best-practices/3.ai-contexts.md new file mode 100644 index 0000000000..7ee3ac2ad8 --- /dev/null +++ b/docs/content/guides/6.best-practices/3.ai-contexts.md @@ -0,0 +1,71 @@ +# Coding with AI + +Alokai aims to boost developer productivity in many ways. E.g. by giving you storefront accelerator and OOTB integrations with 3rd party services. +Now we want to go even further by boosting your productivity with AI. + +## Disclaimer + +AI field is evolving rapidly. New models, new tools, new workflows are emerging every day. +While we do our best to keep this guide updated, we might miss some things. +Revisit this guide regularly and don't follow it blindly. + +## AI Contexts + +Alokai provides a set of AI contexts that can be used to code with AI. +//TODO: explain what are AI contexts + +## Expectations Management + +//TODO: elaborate on this points + +- AI is not a replacement for your knowledge and experience. +- AI is a tool to help you code faster and more efficiently. +- AI is not a replacement for your ability to reason and think. +- AI is just predicts what would be the most likely outcome for the given input. +There's also some randomness added to the process, so the results might be inconcistent. +- AI can make silly mistakes. But it can do amazing things at the same time. Don't get disappointed too fast. +- Don’t extrapolate your vision of intelligence on AI. AI is a different form of intelligence than human intelligence. +It can make silly mistakes. But it can do amazing things at the same time. Don't get disappointed too fast. +- Be flexible with your expectations of the output. +- AI cannot see the results of the code yet. +- AI can forget things. + +## Recommended tools + +### IDEs + +- [Cursor](https://www.cursor.com/) +- [Windsurf](https://windsurf.dev/) + +GitHub Copilot is not recommended. Agent mode is coming soon but we have not tested it yet. + +Alternatives to consider: + +- [Cline](https://cline.bot/) + +### LLM models + +- Claude + +## Workflows + +//TODO: elaborate on this points + +- hands on - you tell the AI what to do +- hands off - you provide the AI with enough context so it can decide what to do + +## General recommendations + +//TODO: elaborate on this points + +- review the code to know what's going on +- keep files small +- edit the context when needed +- when AI goes wrong, ask it why it dit it this way +- don't hesitate to start over again +- ask AI to check the codebase for examples +- copy and paste error messages +- experiment +- don't hesitate to get your hands dirty - sometimes it's faster to do things manually than to explain it to AI +- ask AI to review its own code +- ask AI to read the docs