Skip to content

Commit 0c5ede5

Browse files
committed
docs: refactor on document version
1 parent 04dbab4 commit 0c5ede5

1 file changed

Lines changed: 3 additions & 8 deletions

File tree

docs/references/version.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
---
22
title: Document version
33
---
4-
5-
### Introduction
6-
7-
Each `.chk`, `.yaml` or `.yml` files containing *CHKware* YAML-dsl is a spec. or specification file. Each of these file **MUST** contain a YAML node called *version:*. E.g:
4+
Each `.chk`, `.yaml` or `.yml` [specification files](./console-command#specification-files) or spec contains *CHKware* YAML-dsl. Each of these file **MUST** contain a YAML node called *version:*. E.g:
85

96
```yml
107
version: default:http:0.7.2
@@ -15,11 +12,9 @@ The version string contains a document version. Document version show which vers
1512

1613
The `chk` tool will exit with an error when unsupported document version found.
1714

18-
It's encouraged for user to write document version on the very top of a spec. document, so that it's clearly visible. However it can be written as a top-level key on any place of the document.
19-
20-
Supported document version can be found on corresponding specification reference.
15+
Although `version:` can be written as a top-level key on any place of the spec, it's encouraged to write `version:` on the very top, so that it's clearly visible.
2116

22-
### Format
17+
## Document version format
2318

2419
This version string have 3 parts: `<plugin>:<module>:<number>`, e.g: `default:http:0.8.0`
2520

0 commit comments

Comments
 (0)