Skip to content

Commit c73e8c3

Browse files
committed
Add version reference
1 parent a046e7c commit c73e8c3

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Version specification reference
3+
---
4+
5+
:::note
6+
- This page should be use as reference for specification files.
7+
- This page is subject to change. It is requested to check this page frequently.
8+
:::
9+
10+
### Introduction
11+
12+
13+
The Version specification format is how someone write a document version. Usually we encourage user to write document version on the very top of a specification document, so that you don't miss it. However it can be written as a top-level key on any place of the document. This is how it looks like:
14+
15+
```yaml
16+
version: default:http:0.7.2
17+
...
18+
```
19+
20+
Document version specifies which version of document current specification contents are written in. Simply think that, if someone wrote a document in a version that is not supported by the `chk` toolset currently installed: It will exit with an error. For example, if you run following in command-line:
21+
22+
```bash
23+
$ chk
24+
Usage: ...
25+
26+
v0.2.0 | version strings: 0.7.2
27+
...
28+
```
29+
- V0.2.0 is the tool version here
30+
- 0.7.2 is the document version it supports
31+
32+
If you have a document that have `version: default:http:0.8.0`, then this command would not be able to run it.
33+
34+
### Format
35+
36+
This version string have 3 parts: `<plugin>:<module>:<number>`, e.g: `default:http:0.8.0`
37+
38+
- plugin: Name of the plugin that supports current specification. `default` means it part of core system. If you see other value it would mean you need to install that plugin to use the document.
39+
- module: A plugin can install multiple module on registration. So, `http` is the module name in `chk http ..`. Usually these are registered as sub-commands to `chk`.
40+
- number: the document version in [SEMVER](https://semver.org/) format.
41+
42+
**`important`** This node have to be available on each document.
43+
44+
### Support document versions:
45+
- 0.7.2
46+

0 commit comments

Comments
 (0)