Skip to main content

Embedded Views

Embedded Views Header Image

Managing technical documentation across multiple platforms can be challenging and time-consuming.

With Embedded Views, your dbdocs project becomes the single source of truth for your database. You can now embed your database documentation into platforms like Notion, Confluence, Miro, or even your own website. This allows users to track changes, view notes, adjust detail levels, and benefit from live updates—all in one place.

How does it work?​

Define embedding content​

Depending on what kind of story you want to tell, you can:

  1. Handpick a few tables of the doc (instead of sharing the whole diagram).
  2. Choose whether the information should be presented in Document View or Diagram View.

Live examples​

For instance, when developing a new feature for my e-commerce project, I want to demonstrate relationship between products and orders , I would want to create a Diagram View that selects all the tables that are related to these two concepts.

For example, below is the real diagram view for products and orders table:

On the other hand, I might want to crunch the details of each tables, I would want to create a Document View of that table, which is more optimized for viewing physical and metadata of a single table.

For example, below is the real document view of products table:

Version pinning​

You can choose to either sync the embedded view with the latest version or pin it to a specific version.

This option gives you control over how your documentation evolves based on your needs. For example:

  • For live docs that need to stay updated, syncing ensures your embeds always show the latest data.
  • For technical docs tied to a specific feature or technical decision, pinning helps preserve that exact version for future reference.

Get started​

To create your first embedded view, make sure you have a document built in dbdocs. You can generate embedding links in two ways:

  1. Wiki & Master Diagram Page: In these pages, you’ll find “Embed” buttons within the document and diagram sections of each table. Simply click these buttons to create an embedded view for that section. What you see is what you get. Create embedded views by wiki page

  2. Share button: You can view existing embedded views and create new ones by using the share button. Create embedded views by share button

After that, you can create the embedded link directly from the modal and paste directly to your documentation tool.

Create and embed notion

Happy documenting!

FAQ​

If the project is in private mode, does it affect the viewing permission of the embedding views? The embedded content can be viewed by anyone who has the link. It is independent of the project's private mode.