Skip to content

Commit 078ae16

Browse files
Update file
1 parent 7a6878f commit 078ae16

File tree

1 file changed

+18
-31
lines changed

1 file changed

+18
-31
lines changed

docs/FAQ.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,40 @@
22

33
## What is Dev-Docs?
44

5-
Dev-Docs is an AI-powered documentation tool that helps you automatically generate and manage documentation for your codebase. It provides a VS Code extension with features like context generation, API documentation, and AI-assisted question answering.
5+
Dev-Docs is a VS Code extension that uses AI to automatically generate and manage documentation for your codebase. It can create both internal documentation for developers and external documentation for users.
66

77
## How do I install Dev-Docs?
88

9-
You can install the Dev-Docs extension from the VS Code marketplace. Search for "Dev-Docs" and click Install.
9+
You can install Dev-Docs from the VS Code marketplace. Search for "Dev-Docs" and click "Install".
1010

1111
## How do I generate documentation with Dev-Docs?
1212

13-
To generate documentation:
14-
1. Open a code file in VS Code
15-
2. Press Shift+Cmd+D (Mac) or Shift+Ctrl+D (Windows/Linux)
16-
3. Select the type of documentation you want to generate
13+
You can generate documentation by right-clicking a file in VS Code and selecting "Generate Documentation" from the context menu, or by using the keyboard shortcut Shift+Cmd+D (Mac) or Shift+Ctrl+D (Windows/Linux).
1714

1815
## What types of documentation can Dev-Docs generate?
1916

20-
Dev-Docs can generate:
21-
- High-level context for files and folders
22-
- API documentation
23-
- User-facing external documentation
24-
- Internal documentation
17+
Dev-Docs can generate internal code documentation, external API documentation, high-level context for folders, OpenAPI specifications, and more.
2518

26-
## How does Dev-Docs use AI?
19+
## How do I customize the documentation generation?
20+
21+
You can customize the documentation generation by modifying the `dev-docs.json` file in your project root. This file allows you to specify which code elements to document, output folders, AI prompts, and more.
2722

28-
Dev-Docs uses AI to:
29-
- Analyze your code and generate relevant documentation
30-
- Answer questions about your codebase
31-
- Identify gaps in existing documentation
32-
- Suggest improvements to documentation
23+
## Can Dev-Docs integrate with my existing documentation workflow?
3324

34-
## How do I configure Dev-Docs?
25+
Yes, Dev-Docs can integrate with existing documentation workflows. It can generate Markdown files that can be used with static site generators like Docusaurus, and can push changes to Git repositories.
3526

36-
You can configure Dev-Docs by modifying the `dev-docs.json` file in your project root. This allows you to customize options like:
37-
- Which files/folders to include
38-
- Documentation output location
39-
- AI prompts and settings
27+
## Is Dev-Docs suitable for large projects?
4028

41-
## Can I use Dev-Docs with GitHub?
29+
Yes, Dev-Docs is designed to handle large projects. It includes features like folder context generation and multi-file documentation that are specifically useful for complex codebases.
30+
31+
## How does Dev-Docs use AI?
4232

43-
Yes, Dev-Docs integrates with GitHub. You can configure it to automatically generate documentation on commits and pull requests.
33+
Dev-Docs uses AI to analyze your code, generate documentation content, identify missing documentation, and answer questions about your codebase. The AI capabilities can be customized through the `dev-docs.json` configuration file.
4434

45-
## Is Dev-Docs free to use?
35+
## Is my code secure when using Dev-Docs?
4636

47-
Dev-Docs offers both free and paid plans. The VS Code extension is free to install, but some advanced AI features may require a paid subscription.
37+
Dev-Docs processes your code locally on your machine. No code is sent to external servers. Only the generated documentation can optionally be synced to Dev-Docs Cloud if you choose to use that feature.
4838

49-
## Where can I get help if I have issues?
39+
## How do I get support for Dev-Docs?
5040

51-
You can get help by:
52-
- Checking the Dev-Docs documentation
53-
- Asking a question using the "Ask Dev-Docs A Question" command in VS Code
54-
- Filing an issue on the Dev-Docs GitHub repository
41+
You can get support for Dev-Docs by visiting our website at dev-docs.io or by opening an issue on our GitHub repository.

0 commit comments

Comments
 (0)