Skip to content

Commit 0d2085e

Browse files
md file
1 parent 330b0f2 commit 0d2085e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This file, "Dev-Docs-Quickstart.md", is a Markdown document that serves as a quickstart guide for using the Dev-Docs tool. It provides step-by-step instructions for new users to get started with Dev-Docs in about five minutes. The guide covers:
7+
8+
1. Creating an account on dev-docs.io
9+
2. Opening a sample repo in GitHub Codespaces
10+
3. Installing and setting up the Dev-Docs extension in VS Code
11+
4. Generating onboarding documentation for a code file
12+
5. Creating user-facing documentation
13+
14+
The document includes visual aids (images) to help users follow along with each step. It also briefly explains how Dev-Docs works, mentioning the `dev-docs.json` configuration file and the tool's customization capabilities. This quickstart guide is designed to give users a quick and practical introduction to the Dev-Docs platform and its core features.
15+
16+

0 commit comments

Comments
 (0)