Skip to content

Commit 5cec10f

Browse files
committed
fix label headings
1 parent 419f7fe commit 5cec10f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,43 +54,43 @@ Edit pre-existing documentation for consistency, accuracy, style and application
5454

5555
Create or revise a document to better reflect an understanding-oriented [explanation](https://diataxis.fr/explanation/).
5656

57-
### good first issue
57+
#### good first issue
5858

5959
An ideal task to start with. Marking issues with this label is a widely adopted [GitHub convention](https://github.com/topics/good-first-issue).
6060

61-
### help wanted
61+
#### help wanted
6262

6363
Another [GitHub convention](https://github.com/topics/help-wanted) to indicate that a project welcomes community help with an issue.
6464

65-
### how-to
65+
#### how-to
6666

6767
Create or revise a document to better reflect a [how-to guide](https://diataxis.fr/how-to-guides/) to achieve a specific goal.
6868

69-
### new
69+
#### new
7070

7171
Adding new or missing documentation for a specific tool, feature, or function.
7272

73-
### oda-admin
73+
#### oda-admin
7474

7575
Tasks relating to the admin of the Open Documentation Academy (ODA) project.
7676

77-
### reference
77+
#### reference
7878

7979
Create or revise a document to better reflect a technical description to use as [reference](https://diataxis.fr/reference/) material.
8080

81-
### review
81+
#### review
8282

8383
Review pre-existing documentation for quality, accuracy and consistency. This work may require small updates to the original documentation and/or the creation of sub-tasks to address any detected and substantial shortcomings.
8484

85-
### size
85+
#### size
8686

8787
This is our estimation of effort and complexity. Size values range from 1 to 8, representing _least effort_ to _most effort_ respectively. These numbers follow the [Fibonacci ### sequence](https://en.wikipedia.org/wiki/Fibonacci_sequence) sequence of 1, 2, 3, 5, 8, with size 8 likely to be a significant undertaking.
8888

89-
### tutorial
89+
#### tutorial
9090

9191
Develop, write, edit or update a [tutorial](https://diataxis.fr/tutorials/). Tutorials are often the hardest kinds of documentation to write or update because they primarily require good teaching skills and perception, before you even start writing.
9292

93-
### update
93+
#### update
9494

9595
Update potentially outdated instructions, commands, or version numbers. These tasks might include release notes, version numbers, new command line arguments and features, and even complete overhauls when a major release occurs.
9696

0 commit comments

Comments
 (0)