Skip to main content
Vault documentation covers secrets management, encryption as a service, privileged access management, and the Vault HTTP API. It is versioned and stored in content/vault/.

​
Content directory

content/vault/
├── global/           # Shared assets used across versions
├── v1.4.x/
├── v1.5.x/
├── v1.6.x/
├── v1.7.x/
├── v1.8.x/
├── v1.9.x/
├── v1.10.x/
├── v1.11.x/
├── v1.12.x/
├── v1.13.x/
├── v1.14.x/
├── v1.15.x/
├── v1.16.x/
├── v1.17.x/
├── v1.18.x/
├── v1.19.x/
├── v1.20.x/
└── v1.21.x/
Each version directory follows the standard structure: 
content/vault/<version>/
├── content/         # Markdown content files
├── data/            # Navigation sidebar JSON files
└── public/img/      # Image assets

​
URL base paths

Vault content is served under two URL base paths:
  • /api-docs/ — Vault HTTP API reference
  • /docs/ — Vault conceptual and operational documentation

​
Available versions

Versions v1.4.x through v1.21.x are present in the repository. The global/ directory contains content shared across all versions.
Vault uses branch names in the format vault/<YYYYMM> for upcoming minor releases (for example, vault/202511). This differs from most other products that use <product>/<exact_release_number>. Check with the Vault tech writer team for the current assembly branch name.
Older versions (v1.6.x and earlier) may fail migration scripts with a “content directory not found” error, indicating a different directory structure in the source repository. Confirm the structure before editing older versions.

​
Exclusion directives

Vault supports exclusion directives (supportsExclusionDirectives: true). This means certain pages can be excluded from the content output using special directives in the source. Take care when restructuring content to preserve any existing exclusion annotations.

​
Finding and editing Vault docs

1

Find the version directory

List the available version directories:
ls content/vault/
2

Navigate to the content files

Vault’s content files are in the content/ subdirectory within each version folder:
ls content/vault/v1.21.x/content/
3

Edit the file

Open the .mdx file you want to change. For pages that appear in both the docs/ and api-docs/ base paths, make sure you’re editing the right subdirectory.
4

Update navigation if needed

Navigation sidebar data is in content/vault/<version>/data/. Add new files to the relevant JSON file to make them appear in the sidebar.

​
Product configuration reference

AttributeValue
productSlugvault
contentDircontent (in source repo)
websiteDirwebsite (in source repo)
dataDirdata
assetDirpublic/img
basePathsapi-docs, docs
versionedDocstrue
supportsExclusionDirectivestrue

Build docs developers (and LLMs) love

Get started for freeTalk to us