Skip to content

Commit 74e6ca8

Browse files
committed
add convention to docs
1 parent ddd10d6 commit 74e6ca8

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/contributing/platforms/versioning.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,21 @@ Versioning allows for the maintenance of multiple versions of the same documenta
1111
To create a versioned page:
1212

1313
1. Ensure the original page already exists.
14-
2. Create a new file with the same name as the original, but append `__v{VERSION}` to the filename (before the extension).
14+
2. Create a new file with the same name as the original, but append `__v{VERSION}` (two underscores) to the filename before the extension.
1515

16-
For example, to create version 2.2.0 of `index.mdx`:
16+
**The version should follow one of these two formats:**
17+
- Major version only (for general version ranges): `__v{MAJOR}.x`
18+
- Full semantic version (for specific versions): `__v{MAJOR}.{MINOR}.{PATCH}`
19+
20+
For example:
1721

1822
```
1923
index.mdx (original)
20-
index__v2.0.0.mdx (version 2.0.0)
24+
index__v7.x.mdx (version 7.x.x)
25+
index__v7.1.0.mdx (specific version 7.1.0)
2126
```
2227

28+
2329
## Versioning Platform Includes
2430

2531
Pages in the `platform-includes` folder can be versioned using the same method. However, the root page referencing these includes must also be versioned.
@@ -30,11 +36,11 @@ Pages in the `platform-includes` folder can be versioned using the same method.
3036
docs/
3137
├── getting-started/
3238
│ ├── index.mdx
33-
│ └── index__v2.mdx
39+
│ └── index__v7.x.mdx
3440
└── platform-includes/
3541
└── configuration/
3642
├── example.mdx
37-
└── example__v2.mdx
43+
└── example__v7.x.mdx
3844
```
3945

4046
## Version Selection and User Experience

0 commit comments

Comments
 (0)