From 7b1de5cfea06af40fdd453b7bdeaa874ea28c42a Mon Sep 17 00:00:00 2001
From: Samyak Jain <56000318+samyakkkk@users.noreply.github.com>
Date: Sat, 22 Jun 2024 17:28:15 +0530
Subject: [PATCH 1/3] (feat)- first draft
---
readme.md | 83 +++++++++++++++----------------------------------------
1 file changed, 22 insertions(+), 61 deletions(-)
diff --git a/readme.md b/readme.md
index 2c2778fc..c256ad93 100644
--- a/readme.md
+++ b/readme.md
@@ -3,96 +3,57 @@
-Dash AI
+CommandDash
[](https://marketplace.visualstudio.com/items?itemName=WelltestedAI.fluttergpt&ssr=false#overview) [](/LICENSE)
-Your Flutter AI Autopilot powered with Gemini Code & Vision
+Turn documentation into IDE Agents
-----------------
-Dash AI is an open-source coding assistant being built for Flutter Devs. It is aimed to not only write code, but also run and debug it. **This allows Dash AI to assist beyond code completion, and autopilot routine tasks for you.**
+Modern software is built using 3rd party APIs and SDKs. But integrating them is time-taking, requiring to read docs and paste snippets.
+CommandDash enables you to **skip reading documentation, and integrate any API or SDK with an IDE agent trained on the docs, examples and issues.**
-- ✨ Powered by Gemini
-- 🤝 Integrated Dart Analyzer
-- 👨🏼💻 For and by Flutter Engineers
-
+
-Our vision is to build a single-command assistant that automates tedious development tasks. Enabling both seasoned and beginner Flutter devs to focus on the creativity and innovation, bringing their app ideas to life faster.
+Currently in Beta, CommandDash is being built in [open-sourced](https://github.com/CommandDash/commanddash) with the community.
-## The Mini-Engineer Vision
-Engineering a feature for an app requires multiple iterations of writing code, running tests and debugging to meet the end-user requirements. Dash AI is designed to assist you through the entire process.
+## FAQs
-Imagine asking: *"Implement this JIRA ticket for me"*
+1. **How safe and secure is it to use, and can you explain why?**
+- CommandDash is powered by Google's Gemini Models and is secure to use for personal usage or work - [Safety and Security Guidelines](https://blog.google/technology/ai/google-gemini-ai/#responsibility-safety)
-```mermaid
-graph TD
-A(Dash AI)
-A --> |Select relevant code| B(Break the task into steps)
-B --> |For each step|C{Refactor code}
-C --> |Generate| D(Exploratory Tests)
-D --> |Tests Fail| C
-D --> |Fails > 3 times| E(Human Overrides)
-E -->|Passes| F(Move to next step)
-D -->|Passes| F(Move to next step)
-F -->|All completed| G(Voila! Task Accomplished)
-```
+2. **Do I need to pay to use CommandDash?**
-We have been able to build internal MVPs of such capablilties in a copilot. And are now sharing a roadmap with the community to make it available in production for everyone.
+- Gemini Flash 1.5 offers both free and paid plans. Please check the [pricing](https://ai.google.dev/pricing) here.
-## Roadmap
+The free plan suffices for using CommandDash 🥳
-To build a mini-engineer with human developer like abilities, we need to provide Gemini LLMs the same access and information that we human devs have. This includes:
-
-
-
-**1. Full Contextual Knowledge**
-To perform a task, humans or LLMs both need to understand the complete contextual code. This could be accomplished by integrating with Dart analyzer and embedding matching.
-
- - [x] Dart Analyzer Integration
- - [x] Manually attach code objects.
- - [x] Basic auto code extraction.
- - [x] Semantic match similar documents.
- - [ ] Advanced auto code extraction.
- - [ ] Auto identify file groups based on command.
-
-**2. Latest Syntax and Dependencies Data**
-To keep up with evolving programming languages and coding practices, we'll use Retrieval Augmented Generation (RAG). This will ensure our Language Models can produce up-to-date code. By integrating the latest information and working with the community, we aim to build the most robust Flutter dataset.
-
- - [ ] Allow generative search across pub.dev.
- - [ ] Refer latest trusted sources for documentation.
- - [ ] Output code for the dependency version installed in the project.
- - [ ] Allow mechanism to update to latest dependency versions.
- - [ ] Choose from a range of trusted code practices and architecture styles.
-
-**3. Ability to Write, Run and Debug Code**
-Modern LLMs are multimodal, understanding text, code, visuals, and even audio. When connected to Dart Tools (analyzer, debugger, devtools) and Dart Runtime (VM), they can leverage their multimodal capabilities to not only write code but also:
-
- - [ ] Write code across multiple files.
- - [ ] Run the tests or app by itself.
- - [ ] Read the console logs and iterate code.
- - [ ] Observe to device screen (multimodality) and interact with the app, to verify if features are met.
-
-This allows us to mimic developer behavior and automate large-scale tasks in their entirety. We are setting a timeline of 4-6 months to achieve all of the above milestones.
+3. **I am an Android Studio user. Can I use CommandDash?**
+- We are coming soon for IntelliJ-based IDEs. *🤫 Secret: most of our core logic is written in Dart, allowing us to ship on any platform very very fast!*
## Contributing
-A coding assistant for all is best built when all of us contribute. You can make contributions to the VSCODE or IntelliJ extension or also to [CommandDash CLI](https://github.com/Welltested-AI/commanddash) shared between the extensions.
+You can make contributions to the VSCODE or IntelliJ extension or also to [agents engine](https://github.com/CommandDash/packages) shared between the extensions.
### Ways to contribute
-- **File feature requests**: Suggest features that'll make your development process easier in the [issues board](https://github.com/Welltested-AI/fluttergpt/issues).
+- **File feature requests**: Suggest features that'll make your development process easier in the [issues board](https://github.com/CommandDash/commanddash//issues).
-- **Pick up open issues**: Pick up and fix existing issues open to the community in [issues board](https://github.com/Welltested-AI/fluttergpt/issues).
+- **Pick up open issues**: Pick up and fix existing issues open to the community in [issues board](https://github.com/CommandDash/commanddash/issues).
- **Participate in discussions**: Help by sharing your ideas in the [active discussions](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA) in our community slack.
## Community
-Connect with like minded people building with Flutter and using AI to do so, every step of the way :D [Join Now](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA)
\ No newline at end of file
+Connect with others using or building agents on CommandDash [Join Now](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA) 👋🏼
+
+## License
+
+CommandDash is released under the Apache License Version 2.0. See the [LICENSE](LICENSE) file for more information.
\ No newline at end of file
From 6f2f5af29ad41052e642029558c95042225d7c84 Mon Sep 17 00:00:00 2001
From: Samyak Jain <56000318+samyakkkk@users.noreply.github.com>
Date: Sat, 22 Jun 2024 17:40:44 +0530
Subject: [PATCH 2/3] (fix): copywriting improvements
---
readme.md | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/readme.md b/readme.md
index c256ad93..7f7ebab4 100644
--- a/readme.md
+++ b/readme.md
@@ -9,18 +9,22 @@
[](https://marketplace.visualstudio.com/items?itemName=WelltestedAI.fluttergpt&ssr=false#overview) [](/LICENSE)
-Turn documentation into IDE Agents
+Skip documentation, use IDE Integration Agents
-----------------
-Modern software is built using 3rd party APIs and SDKs. But integrating them is time-taking, requiring to read docs and paste snippets.
+Modern software is built on top of 3rd party APIs and SDKs. But integrating them is time consuming, requiring to manually read docs and copy-paste snippets.
-CommandDash enables you to **skip reading documentation, and integrate any API or SDK with an IDE agent trained on the docs, examples and issues.**
+[CommandDash](https://commanddash.io) enables you to **skip reading documentation, and integrate any API or SDK with an IDE agent upto date with latest documentation, examples and issues.**
+##### 🙌🏼 Open Marketplace of IDE Agents
+##### 🎯 Supports every programming language
+##### 💙 Free to every developer.
+
Currently in Beta, CommandDash is being built in [open-sourced](https://github.com/CommandDash/commanddash) with the community.
From cd732c9353d435cb88619df288e560e5a829f5d1 Mon Sep 17 00:00:00 2001
From: Samyak Jain <56000318+samyakkkk@users.noreply.github.com>
Date: Sat, 22 Jun 2024 17:57:38 +0530
Subject: [PATCH 3/3] (feat): refined copywriting
---
readme.md | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/readme.md b/readme.md
index 7f7ebab4..e67b4a94 100644
--- a/readme.md
+++ b/readme.md
@@ -9,7 +9,7 @@
[](https://marketplace.visualstudio.com/items?itemName=WelltestedAI.fluttergpt&ssr=false#overview) [](/LICENSE)
-Skip documentation, use IDE Integration Agents
+Skip documentation, upgrade to IDE agents
-----------------
@@ -25,8 +25,7 @@ Modern software is built on top of 3rd party APIs and SDKs. But integrating them
##### 🎯 Supports every programming language
##### 💙 Free to every developer.
-Currently in Beta, CommandDash is being built in [open-sourced](https://github.com/CommandDash/commanddash) with the community.
-
+Our vision is to enable developers to seamlessly integrate APIs and SDKs without leaving their IDEs.
## FAQs
@@ -35,28 +34,25 @@ Currently in Beta, CommandDash is being built in [open-sourced](https://github.c
2. **Do I need to pay to use CommandDash?**
-- Gemini Flash 1.5 offers both free and paid plans. Please check the [pricing](https://ai.google.dev/pricing) here.
-
-The free plan suffices for using CommandDash 🥳
+- Gemini Flash 1.5 offers both free and paid plans. Please check the [pricing](https://ai.google.dev/pricing) here.
+ The free plan suffices for using CommandDash 🥳
3. **I am an Android Studio user. Can I use CommandDash?**
-- We are coming soon for IntelliJ-based IDEs. *🤫 Secret: most of our core logic is written in Dart, allowing us to ship on any platform very very fast!*
+- We are coming soon for IntelliJ-based IDEs. *🤫 Secret: most of our core logic is written in Dart, shipped as an executable, allowing us to ship on any platform very fast!*
## Contributing
-You can make contributions to the VSCODE or IntelliJ extension or also to [agents engine](https://github.com/CommandDash/packages) shared between the extensions.
-
-### Ways to contribute
+You can make contributions to the VSCODE or IntelliJ extension or also to the shared [engine](https://github.com/CommandDash/packages).
- **File feature requests**: Suggest features that'll make your development process easier in the [issues board](https://github.com/CommandDash/commanddash//issues).
- **Pick up open issues**: Pick up and fix existing issues open to the community in [issues board](https://github.com/CommandDash/commanddash/issues).
-- **Participate in discussions**: Help by sharing your ideas in the [active discussions](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA) in our community slack.
+- **Add agents to the marketplace**: You can add agents for your most used APIs or SDKs and share it with others to help them easily integrate. [Quickstart](https://www.commanddash.io/docs/quickstart).
## Community
-Connect with others using or building agents on CommandDash [Join Now](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA) 👋🏼
+Connect with others using or publishing agents on CommandDash [Join Now](https://join.slack.com/t/welltested-ai/shared_invite/zt-25u09fty8-gaggH9HbmopB~4tialTrlA) 👋🏼
## License