Dev-Docs Glossary

AI: Artificial Intelligence, used by Dev-Docs to analyze code and generate documentation.

API: Application Programming Interface, a set of protocols and tools for building software applications.

Command Palette: A feature in VS Code accessed via Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac) to run commands.

Context: High-level summary or overview of a codebase, folder, or file generated by Dev-Docs.

dev-docs.json: Configuration file used to customize Dev-Docs behavior and settings.

External Documentation: User-facing documentation generated from codebase for end-users or consumers.

GitHub App: An application that runs automation and integrations on GitHub repositories.

Internal Documentation: Documentation generated for developers working on the codebase.

Markdown: A lightweight markup language used for formatting text, commonly used for documentation.

OpenAPI: A specification for machine-readable interface files for describing, producing, consuming, and visualizing RESTful web services.

Postman Collection: A group of saved API requests that can be organized, documented, and shared.

Static Site Generator: A tool that generates a full static HTML website based on raw data and templates.

VS Code Extension: A plugin that adds features and functionality to Visual Studio Code.

Workflow: An automated process that can be triggered by events in a GitHub repository.