Merge pull request #5 from bootstrapguru/documentation

Documentation

.gitignore

@@ -4,3 +4,5 @@
 /.vagrant
 .phpunit.result.cache
 .env
+docs/.vitepress/dist
+docs/.vitepress/cache

app/Utils/OnBoardingSteps.php

@@ -10,6 +10,7 @@
 
 use function Laravel\Prompts\confirm;
 use function Laravel\Prompts\error;
+use function Laravel\Prompts\password;
 use function Laravel\Prompts\select;
 use function Laravel\Prompts\spin;
 use function Laravel\Prompts\text;
@@ -56,7 +57,7 @@ private function modelExists(): bool
         if (! config('droid.model')) {
             $model = select(
                 label: '🤖 Choose the default Model for the assistant',
-                options: ['gpt-4o', 'gpt-4-turbo', 'gpt-3.5'],
+                options: ['gpt-4o', 'gpt-4-turbo', 'gpt-4-turbo-preview	', 'gpt-3.5-turbo'],
                 default: 'gpt-4o',
                 hint: 'The model to use for the assistant. You can change this later in the configuration file'
             );
@@ -108,7 +109,7 @@ private function configurationFileExists(): bool
     private function APIKeyExists(): bool
     {
         if (! config('droid.api_key')) {
-            $apiKey = text(
+            $apiKey = password(
                 label: '🤖: Enter your OpenAI API key to continue',
                 placeholder: 'sk-xxxxxx-xxxxxx-xxxxxx-xxxxxx',
                 hint: 'You can find your API key in your OpenAI dashboard'

docs/.vitepress/config.mjs

@@ -0,0 +1,46 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Droid Docs",
+  description: "AI Robot that codes for you",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+      nav: [
+          { text: 'Home', link: '/' },
+          { text: 'Features', link: '/features' }
+      ],
+
+      sidebar: [
+          {
+              text: 'Introduction',
+              items: [
+                  { text: 'Who am I', link: '/who-am-i' },
+                  { text: 'Getting Started', link: '/getting-started' },
+                  { text: 'Onboarding', link: '/onboarding' },
+                  { text: 'Features', link: '/features' }
+              ]
+          },
+          {
+              text: 'Core Concepts',
+              items: [
+                  { text: 'Tools', link: '/tools' },
+                  { text: 'Build', link: '/build' }
+              ]
+          },
+          {
+              text: 'Contributing',
+              items: [
+                  { text: 'How to contribute', link: '/how-to-contribute' },
+                  { text: 'Architecture guide', link: '/architecture-guide' },
+                  { text: 'License', link: '/license' },
+                  { text: 'Donation', link: '/donation' }
+              ]
+          }
+      ],
+
+      socialLinks: [
+          { icon: 'github', link: 'https://github.com/bootstrapguru/droid.dev' }
+      ]
+  }
+})

docs/.vitepress/theme/index.js

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+/** @type {import('vitepress').Theme} */
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+}

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/build.md

@@ -0,0 +1,12 @@
+# Build Guide
+
+To build the Droid CLI application, follow these steps:
+
+1. Clone the Droid CLI repository to your local machine.
+2. Navigate to the project directory in the terminal.
+3. Run the following command to build the application:
+   ```sh
+   php droid app:build
+   ```
+
+For more detailed information on building the Droid CLI application using Laravel Zero, refer to the [Laravel Zero documentation](https://laravel-zero.com/docs/build-a-standalone-application).

docs/donation.md

@@ -0,0 +1,7 @@
+# Donation
+
+Support the development of Droid Dev by making a donation.
+
+Your contributions help us maintain and improve Droid Dev for the community.
+
+[Donate Now](https://buy.stripe.com/8wMdTC3Uk7QzaoU3cf)

docs/features.md

@@ -0,0 +1,21 @@
+# Features
+
+🤖 Let me showcase my amazing features that will make your development experience smoother and more efficient. One thing I would like to mention is that I am as good as your input, if I miss something just be more specific and I will do magic! 🪄 
+
+## Code Analysis
+
+I can scan through your project files and folders to read and understand your code. This allows me to make context-aware changes that fit seamlessly into your existing codebase.
+
+## Bug Fixing
+
+Worried about bugs? Leave it to me! I automatically analyze your code to identify common issues and suggest or apply fixes, saving you time and effort. I mean with right inputs, I can do wonders!
+
+## Test Writing
+
+Ensuring your code functions as expected is crucial. I generate comprehensive test cases based on your current code structure to help maintain high-quality code.
+
+## File Creation
+
+Need new files or components? I create them adhering to your project's existing patterns and conventions, ensuring consistency across your codebase.
+
+Let's work together to build something amazing!

docs/getting-started.md

@@ -0,0 +1,40 @@
+# Getting Started
+
+## Installation
+
+Let me guide you through my installation process. Choose your preferred method: I would choose the first one if I were you! 🤖
+
+### Via Curl
+
+Install me with curl:
+
+```sh
+curl -L https://github.com/bootstrapguru/droid.dev/releases/latest/download/droid -o /usr/local/bin/droid
+chmod +x /usr/local/bin/droid
+```
+
+### Via Composer
+
+To install me globally using Composer, run:
+
+```sh
+composer global require droid
+```
+
+### Via GitHub Release
+
+Alternatively, download my built directory from the latest GitHub release:
+
+1. Visit the [Droid Dev GitHub Releases](https://github.com/bootstrapguru/droid.dev/releases).
+2. Download the latest release's build directory.
+3. Extract the files and integrate them into your project.
+
+## Usage
+
+Once installed, activate me with the following command:
+
+```sh
+droid
+```
+
+I will display all my available commands and options. Dive into the documentation to explore my full capabilities and features.

docs/how-to-contribute.md

@@ -0,0 +1,74 @@
+
+
+We appreciate your interest in contributing to droid.dev! There are several ways you can get involved in the project:
+
+## Reporting Issues
+
+If you encounter any issues or bugs while using droid.dev, please report them by following these steps:
+
+1. Navigate to our [Issue Tracker](https://github.com/bootstrapguru/droid.dev/issues).
+2. Check if the issue has already been reported. If it has, you can add any additional information you have.
+3. If the issue has not been reported, create a new issue and provide as much detail as possible, including steps to reproduce the problem and any relevant logs or screenshots.
+
+## Submitting Pull Requests
+
+We welcome pull requests! To submit a pull request, follow these steps:
+
+1. **Fork the Repository:**
+   - Go to our [GitHub repository](https://github.com/bootstrapguru/droid.dev) and click the "Fork" button.
+
+2. **Clone Your Fork:**
+   ```bash
+   git clone https://github.com/your-username/droid.dev.git droid
+   cd droid
+   ```
+
+3. **Create a Branch:**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+4. **Make Your Changes:**
+   - Ensure your code follows the project's coding standards.
+   - Write clear commit messages.
+
+5. **Push Your Changes:**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+6. **Create a Pull Request:**
+   - Go to your forked repository on GitHub.
+   - Click the "New Pull Request" button and select the branch you created.
+   - Provide a clear description of the changes you made and the reason for the changes.
+
+## Coding Standards
+
+To maintain consistency, please ensure your code adheres to the following standards:
+
+- Follow the [JavaScript Standard Style](https://standardjs.com/).
+- Document your code thoroughly with comments.
+- Write tests for new features and bug fixes.
+- Ensure all tests pass before submitting a pull request.
+
+## Improving Documentation
+
+You can also contribute by improving our documentation. If you find any errors or areas that need clarification, follow these steps:
+
+1. **Fork and Clone the Repository** (same steps as above).
+2. **Navigate to the Documentation Directory:**
+   ```bash
+   cd docs
+   ```
+3. **Make Your Changes:**
+   - Edit the markdown files to improve the content.
+4. **Push Your Changes** and **Create a Pull Request** (same steps as above).
+
+## Join the Community
+
+Join our community to stay up-to-date and to discuss ideas and features:
+
+- [GitHub Discussions](https://github.com/bootstrapguru/droid.dev/discussions)
+- [Twitter](https://twitter.com/vijaytupakula)
+
+Thank you for your interest in contributing to droid.dev! Your support and contributions help us improve and grow the project.