Skip to content

Commit c984734

Browse files
(chore): changes to the template for more guidance (#1248)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. --> ## Overview <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. --> ## Checklist <!-- Please complete the checklist to ensure that the PR is ready to be reviewed. IMPORTANT: PRs should be left in Draft until the below checklist is completed. --> - [ ] New and updated code has appropriate documentation - [ ] New and updated code has new and/or updated testing - [ ] Required CI checks are passing - [ ] Visual proof for any user facing features like CLI or documentation updates - [ ] Linked issues closed with keywords --------- Co-authored-by: Manav Aggarwal <manavaggarwal1234@gmail.com>
1 parent 91b7cb2 commit c984734

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

specs/template.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,69 @@ rollkit repository rather than in the specification document.
3535
## References
3636

3737
List any references used or cited in the document.
38+
39+
## General Tips
40+
41+
### How to use a mermaid diagram that you can display in a markdown
42+
43+
```mermaid
44+
45+
sequenceDiagram
46+
title Example
47+
participant A
48+
participant B
49+
A->>B: Example
50+
B->>A: Example
51+
52+
```
53+
54+
```mermaid
55+
56+
graph LR
57+
A[Example] --> B[Example]
58+
B --> C[Example]
59+
C --> A
60+
61+
```
62+
63+
```mermaid
64+
65+
gantt
66+
title Example
67+
dateFormat YYYY-MM-DD
68+
section Example
69+
A :done, des1, 2014-01-06,2014-01-08
70+
B :done, des2, 2014-01-06,2014-01-08
71+
C :done, des3, 2014-01-06,2014-01-08
72+
73+
```
74+
75+
### Grammer and spelling check
76+
77+
The recommendation is to use your favorite spellchecker extension in your IDE like [grammarly], to make sure that the document is free of spelling and grammar errors.
78+
79+
### Use of links
80+
81+
If you want to use links use proper syntax. This goes for both internal and external links like [documentation] or [external links]
82+
83+
At the bottom of the document in [Reference](#references), you can add the following footnotes that will be visible in the markdown document:
84+
85+
[1] [Grammarly][grammarly]
86+
87+
[2] [Documentation][documentation]
88+
89+
[3] [external links][external links]
90+
91+
Then at the bottom add the actual links that will not be visible in the markdown document:
92+
93+
[grammarly]: https://www.grammarly.com/
94+
[documentation]: ../README.md
95+
[external links]: https://github.com/celestiaorg/go-header
96+
97+
### Use of tables
98+
99+
If you are describing variables, components or other things in a structured list that can be described in a table use the following syntax:
100+
101+
| Name | Type | Description |
102+
| ---- | ---- | ----------- |
103+
| `name` | `type` | Description |

0 commit comments

Comments
 (0)