You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/platforms/versioning.mdx
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,15 +11,21 @@ Versioning allows for the maintenance of multiple versions of the same documenta
11
11
To create a versioned page:
12
12
13
13
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.
15
15
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:
17
21
18
22
```
19
23
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)
21
26
```
22
27
28
+
23
29
## Versioning Platform Includes
24
30
25
31
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.
0 commit comments