Skip to content

Commit f978c6a

Browse files
Apply suggestions from code review
Co-authored-by: Brian Muenzenmeyer <[email protected]> Signed-off-by: Claudio W <[email protected]>
1 parent cc3080b commit f978c6a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,8 @@ authors: github_username, another_github_username
275275
A little bit of explanation about the frontmatter:
276276

277277
- `title`: The title of the article. This will be displayed as the title of the page. We recommend that you use the same title as the navigation entry. How to enter navigation entries is explained later in this document.
278-
- `layout`: This must be set so that the Learning page has the same style as the other Learning pages.
279-
- `authors`: A list of the GitHub usernames of the authors of the article. This is used to display the authors' profile pictures on the page. The frontmatter must always have the_utilsatuer_name followed by `, ` the space is important.
278+
- `layout`: This must be set to `learn` so that the new article has the same style as other Learn pages.
279+
- `authors`: A list of the GitHub usernames of the authors of the article. This is used to display the authors' profile pictures on the page. The frontmatter must always have the `github_username` followed by `, `. The comma and space is important.
280280
281281
### Modify the navigation
282282
@@ -321,7 +321,7 @@ To edit an existing article, you need to find the markdown file in the `site/pag
321321
> [!NOTE]
322322
> If you rewrite a big part of the article you can add yourself as an author in the frontmatter. **But** if you only fix a typo or a small part of the article, you don't need to add yourself as an author.
323323

324-
### Accesible MDX components
324+
### Accessible MDX components
325325

326326
#### Codebox
327327

@@ -337,4 +337,4 @@ import http from 'node:http';
337337
'''
338338
```
339339

340-
`cjs` and `mjs` are variant of `js`, it's just to display the correct language in the codebox (cjs = CommonJS, mjs = ES Module).
340+
`cjs` and `mjs` are variants of `js`, it's just to display the correct language in the codebox (cjs = CommonJS, mjs = ES Module).

0 commit comments

Comments
 (0)