# dbdocs documentation

> Official documentation for [dbdocs.io](https://dbdocs.io): publish web-based database documentation from DBML, collaborate with workspaces, and keep docs updated via CI.

For the DBML language specification and CLI, see [DBML docs](https://dbml.dbdiagram.io/llms.txt). For dbdiagram (diagramming app), see [dbdiagram docs](https://docs.dbdiagram.io/llms.txt).

## Getting started

- [Quickstart guide](https://docs.dbdocs.io/): Install `dbdocs` CLI, create a DBML file, and publish your first project.
- [Quick tour](https://docs.dbdocs.io/getting-started/explore): Navigate a published dbdocs project (tables, references, search, relationships, sharing).

## Workspaces

- [Workspaces](https://docs.dbdocs.io/workspaces): Personal vs team workspaces, plan differences, and collaboration features.

## Features

- [Generate DBML from SQL database](https://docs.dbdocs.io/features/generate-dbml-from-db): Use `db2dbml` or `sql2dbml` to produce DBML from existing databases.
- [CI integration](https://docs.dbdocs.io/features/ci-integration): Use `dbdocs token` and CI secrets to run `dbdocs build` automatically.
- [Sharing & collaboration](https://docs.dbdocs.io/features/project-access-control): Public, private, and password-protected projects; guest access and permissions.
- [ER diagrams](https://docs.dbdocs.io/features/relationship-diagrams): Relationship diagrams, saving layouts, and behavior across builds.
- [Embedded views](https://docs.dbdocs.io/features/embedded-views): Embed Document/Diagram views into tools like Notion/Confluence; version pinning vs sync.
- [Schema changelog](https://docs.dbdocs.io/features/schema-changelog): Track schema changes across builds (add/remove/modify by entity type).

## Release notes

- [Release notes](https://docs.dbdocs.io/release-notes): dbdocs.io product updates (new features, improvements, fixes).

## Support

- [Support hours & SLA](https://docs.dbdocs.io/support-sla): Support channels, hours, and response expectations.

## Optional

- [Security & compliance](https://docs.dbdocs.io/security-and-compliance): Index for security and legal pages.
- [Data security](https://docs.dbdocs.io/security-and-compliance/data-security): How data is handled and protected.
- [Privacy policy](https://docs.dbdocs.io/security-and-compliance/privacy-policy): Privacy policy.
- [Terms of service](https://docs.dbdocs.io/security-and-compliance/terms-of-service): Terms of use.
- [Responsible disclosure](https://docs.dbdocs.io/security-and-compliance/responsible-disclosure): Reporting security issues.
- [Product roadmap (Notion)](https://holistics.notion.site/Public-Product-Roadmap-dbx-dbdiagram-dbdocs-dbml-c36af127c86a40919337b61ac6e12a48): Public roadmap for dbx products.