File tree 1 file changed +14
-1
lines changed 1 file changed +14
-1
lines changed Original file line number Diff line number Diff line change @@ -15,6 +15,19 @@ To edit the user guide:
15
15
16
16
We'd like to ask you to familiarize yourself with our [ Contribution Guide] ( CONTRIBUTING.md ) .
17
17
18
+ ## Style Guide
19
+
20
+ We must use CWL standards or CWL open standards when talking about CWL.
21
+ We must use specification only when talking specifically about the CWL
22
+ specification document.
23
+
24
+ Whenever a page is updated we must verify that it does not break existing
25
+ links. The ` make html ` command will fail if Sphinx detects broken links.
26
+ It only works for links managed by Sphinx (i.e. table of contents links,
27
+ or links to Markdown pages). For simple HTML links (e.g. ` < href=> ` or
28
+ markdown external links) pull request reviewers must verify that links
29
+ are still working after the change.
30
+
18
31
### Code examples
19
32
20
33
To include code into a Markdown file you have two options. For external files use
@@ -39,7 +52,7 @@ you will have to customize the Sphinx and Pygments settings.
39
52
To preview Pygments output with different styles, use their
40
53
[ Pygments demo tool] ( https://pygments.org/demo/ ) .
41
54
42
- ### Links
55
+ ### Creating Links
43
56
44
57
Sphinx and the theme are configured to auto-generate anchor slug
45
58
links for sections. So sections like `` ## cwl standard `` are translated
You can’t perform that action at this time.
0 commit comments