Skip to content

Commit e5aaeee

Browse files
Create file
1 parent dbd91d6 commit e5aaeee

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/Glossary.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Dev-Docs Glossary
2+
3+
AI: Artificial Intelligence, used by Dev-Docs to automatically generate documentation.
4+
5+
API: Application Programming Interface, a set of protocols and tools for building software applications.
6+
7+
Command Palette: A feature in VS Code to quickly access commands using keyboard shortcuts.
8+
9+
Dev-Docs: An AI-powered documentation tool and VS Code extension for generating and managing code documentation.
10+
11+
dev-docs.json: A configuration file used to customize Dev-Docs settings and behavior.
12+
13+
External Documentation: Documentation intended for users or consumers of a software project, separate from internal code documentation.
14+
15+
GitHub Codespaces: A cloud-based development environment provided by GitHub.
16+
17+
Internal Documentation: Documentation intended for developers working on a software project, often embedded within or alongside code.
18+
19+
Markdown: A lightweight markup language used for formatting text, commonly used for documentation.
20+
21+
OpenAPI: A specification for describing RESTful APIs, formerly known as Swagger.
22+
23+
Postman Collection: A format for defining and sharing API requests.
24+
25+
Static Site Generator: A tool that generates a full static HTML website from raw data and templates.
26+
27+
VS Code: Visual Studio Code, a popular source code editor developed by Microsoft.
28+
29+
Workspace: The root directory of a project or collection of related files in VS Code.

0 commit comments

Comments
 (0)