Skip to main content
The Well-Architected Framework documentation provides architectural guidance and best practices for deploying and operating HashiCorp products. It is not versioned — all content lives in a single directory tree tracked on main.

​
Content directory

content/well-architected-framework/
├── docs/              # Markdown content files
├── data/              # Navigation sidebar JSON files
├── img/               # Image assets
├── redirect-wip.jsonc # Work-in-progress redirect rules
└── redirects.jsonc    # Active redirect rules
Because the Well-Architected Framework is unversioned, there are no vX.Y.z/ subdirectories. All content lives directly under content/well-architected-framework/docs/.

​
Versioning behavior

The Well-Architected Framework does not use directory-based versioning. All edits go directly to content/well-architected-framework/docs/. The content API tracks a single version on main.

​
Finding and editing Well-Architected Framework docs

1

Navigate to the content directory

All Well-Architected Framework content files are in:
ls content/well-architected-framework/docs/
2

Edit the file

Open the .mdx file you want to change. Since there are no version subdirectories, the file path maps directly to the URL route.
3

Update navigation if needed

Navigation sidebar data is in content/well-architected-framework/data/. Add new files to the relevant JSON file to make them appear in the sidebar.

​
Product configuration reference

AttributeValue
productSlugwell-architected-framework
contentDirdocs (in source repo)
websiteDirwebsite (in source repo)
dataDirdata
assetDirimg
versionedDocsfalse

Build docs developers (and LLMs) love

Get started for freeTalk to us