Skip to content

Commit 5c07689

Browse files
Update file
1 parent 9a5b4c4 commit 5c07689

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

src/extension.ts

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1-
# Dev-Docs VSCode Extension
1+
# devdocs.helloWorld Documentation
22

3-
## Overview
3+
## Brief Description
4+
The `devdocs.helloWorld` command opens the Dev-docs interface, allowing users to access and manage their project documentation.
45

5-
Dev-Docs is a Visual Studio Code extension that helps developers generate and manage documentation for their codebase. It provides features for automatically generating documentation, organizing documentation files, and integrating with external documentation systems.
6+
## Usage
7+
To use the `devdocs.helloWorld` command, you can either:
8+
1. Run it from the VSCode command palette
9+
2. Use the keyboard shortcut assigned to it
10+
3. Click on the "Open Dev-docs" button in the Dev-docs sidebar
611

7-
Key features include:
12+
## Parameters
13+
This command does not accept any parameters.
814

9-
- Automatic documentation generation for code files and symbols
10-
- Organization of documentation into general, reference, context, and misc categories
11-
- Integration with external documentation systems and Git repositories
12-
- Custom AI-powered documentation generation and summarization
13-
- Search capabilities across documentation
14-
- API documentation generation from code
15+
## Return Value
16+
This command does not return a value. Instead, it opens the Dev-docs interface within VSCode.
1517

16-
The extension aims to streamline the process of creating and maintaining technical documentation alongside code. It leverages AI and static analysis to generate documentation content while providing developers with tools to organize and customize that content.
18+
## Examples
19+
20+
### Opening Dev-docs from the command palette
21+
1. Open the VSCode command palette (Ctrl+Shift+P or Cmd+Shift+P on Mac)
22+
2. Type "Open Dev-docs" and select the `Dev-docs: Open Dev-docs` command
23+
24+
### Using a custom keyboard shortcut
25+
1. Open VSCode settings
26+
2. Search for "keyboard shortcuts"
27+
3. Add a new shortcut for the `devdocs.helloWorld` command
28+
4. Use your custom shortcut to quickly open Dev-docs
29+
30+
## Notes or Considerations
31+
- Ensure you have initialized Dev-docs for your project before using this command
32+
- The Dev-docs interface will open in a new editor tab within VSCode
33+
- If you have previously opened Dev-docs and have unsaved changes, they will be preserved when reopening
34+
- This command is part of the Dev-docs extension and requires the extension to be installed and activated in your VSCode environment

0 commit comments

Comments
 (0)