nodejs.org
nodejs.org copied to clipboard
Meta: having a doc/guide about how to write page
We need to create a comprehensive documentation guide similar to ADDING_LEARN_PAGE but extended to cover all content on the nodejs.dev website.
The documentation should include the following sections:
-
File Location and Structure
- What does the location of the markdown file reflect?
-
Front Matter Requirements
- Understand and require front matter (if adding a blog post, include the author in
apps/site/authors.json).
- Understand and require front matter (if adding a blog post, include the author in
-
Navigation Entries
- If adding a learn or about page, how to add an entry in the navigation.
-
React Components and Metadata
- Which React component is accessed in the case of MDX and which metadata is included (e.g.,
displayName).
- Which React component is accessed in the case of MDX and which metadata is included (e.g.,
i had started to write a first draft.
https://github.com/nodejs/nodejs.org/tree/meta-learn