diff --git a/docs/main.md b/docs/main.md new file mode 100644 index 000000000..75d24750b --- /dev/null +++ b/docs/main.md @@ -0,0 +1,60 @@ + + + # Dev-Docs VS Code Extension Quickstart + +## Prerequisites + +1. Install Visual Studio Code +2. Install the Dev-Docs VS Code extension from the VS Code marketplace + +## Getting Started + +1. **Install the Extension** + - Open VS Code + - Go to Extensions (Ctrl+Shift+X) + - Search for "Dev-Docs" + - Click "Install" + +2. **Initialize Dev-Docs in Your Project** + - Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) + - Type "dev-docs: Initialize Dev-Docs" and select it + - This creates a `dev-docs.json` file in your project root + +3. **Enable Markdown Mode** + - Open the Command Palette + - Search for "dev-docs: turn on markdown mode" + - Click "Yes" to enable + +4. **Open the Dev-Docs Editor** + - Use the Command Palette + - Search for "Open Dev-docs" and select it + +5. **Create Your First General Document** + - The Dev-Docs editor will open to a general document + - Start typing to add content (it autosaves) + +6. **Create Documentation for Specific Code Files** + - Right-click on any code file in the Explorer + - Select "Open Dev-doc for current file" + +7. **Generate Documentation with AI** + - Select a file you want to document + - Open the Command Palette + - Search for "dev-docs: generate documentation" or use the shortcut Shift+Cmd+D (Mac) or Shift+Ctrl+D (Windows/Linux) + +8. **Customize AI Generation** + - Open `dev-docs.json` in your project root + - Add or modify the `quickDoc` and `ai` sections to customize prompts and behavior + +9. **Sync to Dev-Docs Cloud (Optional)** + - Sign in to Dev-Docs in VS Code + - Open any Dev-Docs document + - Use Cmd+S (Mac) or Ctrl+S (Windows/Linux) to sync to the cloud + +## Next Steps + +- Explore additional commands in the Command Palette +- Configure your `dev-docs.json` file for more advanced options +- Check out the full documentation for more features and capabilities + + \ No newline at end of file