nodejs.org icon indicating copy to clipboard operation
nodejs.org copied to clipboard

Meta: having a doc/guide about how to write page

Open AugustinMauroy opened this issue 1 year ago • 1 comments

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:

  1. File Location and Structure
    • What does the location of the markdown file reflect?
  2. Front Matter Requirements
    • Understand and require front matter (if adding a blog post, include the author in apps/site/authors.json).
  3. Navigation Entries
    • If adding a learn or about page, how to add an entry in the navigation.
  4. React Components and Metadata
    • Which React component is accessed in the case of MDX and which metadata is included (e.g., displayName).

AugustinMauroy avatar Sep 12 '24 11:09 AugustinMauroy

i had started to write a first draft.

https://github.com/nodejs/nodejs.org/tree/meta-learn

AugustinMauroy avatar Sep 24 '24 09:09 AugustinMauroy