v2

Migration Guide

Migrate from v1 to v2

1 min read

Migration Guide

This guide helps you migrate from HermesDocs v1 to v2.

Path-Based Versioning

v2 uses path-based versioning instead of query parameters:

  • v1: /docs?version=v1 and /docs/getting-started?version=v1
  • v2: /docs/v1 and /docs/v1/getting-started

Old URLs automatically redirect to the new format.

Configuration Changes

The siteConfig structure is unchanged. Ensure your defaultVersion points to the correct version.

Content Updates

Add version to frontmatter for version-specific pages:

---
title: My Page
version: 'v2'
---

Pages without version appear in all versions.