Find the right page or section

The YugabyteDB docs are divided into several sections:

  • YugabyteDB Core is the overview documentation for YugabyteDB
  • YugabyteDB Anywhere documents YugabyteDB Anywhere
  • YugabyteDB Managed documents YugabyteDB Managed
  • Releases contains release notes and other information related to releases
  • Integrations documents third-party integrations
  • Reference contains detailed reference and architecture information about functions, features, and interfaces
  • FAQ contains frequently-asked questions on a variety of topics
  • Misc contains legal information and the (deprecated) YEDIS subsystem

YugabyteDB core docs

The core docs are landing pages with overview and getting-started information. Pages in this section should have a high-level overview of a feature, what's supported, limitations, and a link to any roadmap GitHub issues. These docs pages can have "Further reading" sections, where you can add links to blogs or Reference section docs as appropriate.

Explore section

Think of the pages in the Explore section as a self-guided tour of YugabyteDB. When you're reading a page in this section, you should be able to get a good sense of how the feature works. The page may not answer every question you have, but should point you to the reference page where you can find that information.

Reference docs

Reference docs should be comprehensive and, above all, accurate. This applies to other doc types, but is especially important for reference docs, as they should be the ultimate source of truth for users.

Here are some examples of reference docs in our documentation:

Design docs on GitHub

We also have design docs in GitHub. These design docs should be referenced from the Reference section in the docs.

Next steps

Now that you know where your page should go, build the docs locally and start editing.