Skip to content

Commit f368112

Browse files
committed
docs: add notes for ai contexts doc
1 parent a8b041e commit f368112

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Coding with AI
2+
3+
Alokai aims to boost developer productivity in many ways. E.g. by giving you storefront accelerator and OOTB integrations with 3rd party services.
4+
Now we want to go even further by boosting your productivity with AI.
5+
6+
## Disclaimer
7+
8+
AI field is evolving rapidly. New models, new tools, new workflows are emerging every day.
9+
While we do our best to keep this guide updated, we might miss some things.
10+
Revisit this guide regularly and don't follow it blindly.
11+
12+
## AI Contexts
13+
14+
Alokai provides a set of AI contexts that can be used to code with AI.
15+
//TODO: explain what are AI contexts
16+
17+
## Expectations Management
18+
19+
//TODO: elaborate on this points
20+
21+
- AI is not a replacement for your knowledge and experience.
22+
- AI is a tool to help you code faster and more efficiently.
23+
- AI is not a replacement for your ability to reason and think.
24+
- AI is just predicts what would be the most likely outcome for the given input.
25+
There's also some randomness added to the process, so the results might be inconcistent.
26+
- AI can make silly mistakes. But it can do amazing things at the same time. Don't get disappointed too fast.
27+
- Don’t extrapolate your vision of intelligence on AI. AI is a different form of intelligence than human intelligence.
28+
It can make silly mistakes. But it can do amazing things at the same time. Don't get disappointed too fast.
29+
- Be flexible with your expectations of the output.
30+
- AI cannot see the results of the code yet.
31+
32+
## Recommended tools
33+
34+
### IDEs
35+
36+
- [Cursor](https://www.cursor.com/)
37+
- [Windsurf](https://windsurf.dev/)
38+
39+
GitHub Copilot is not recommended. Agent mode is coming soon but we have not tested it yet.
40+
41+
Alternatives to consider:
42+
43+
- [Cline](https://cline.bot/)
44+
45+
### LLM models
46+
47+
- Claude
48+
49+
## Workflows
50+
51+
//TODO: elaborate on this points
52+
53+
- hands on - you tell the AI what to do
54+
- hands off - you provide the AI with enough context so it can decide what to do
55+
56+
## General recommendations
57+
58+
//TODO: elaborate on this points
59+
60+
- review the code to know what's going on
61+
- keep files small
62+
- edit the context when needed
63+
- when something goes wrong retry or revert
64+
- ask AI to check the codebase for examples
65+
- copy and paste error messages
66+
- experiment
67+
- don't hesitate to get your hands dirty - sometimes it's faster to do things manually than to explain it to AI
68+
- ask AI to review its own code
69+

0 commit comments

Comments
 (0)