Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
AugustinMauroy opened this issue Sep 12, 2024 · 1 comment
Open

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

AugustinMauroy opened this issue Sep 12, 2024 · 1 comment
Labels
meta Meta Issues for Administration of the Website Team

Comments

@AugustinMauroy
Copy link
Contributor

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 AugustinMauroy added the meta Meta Issues for Administration of the Website Team label Sep 12, 2024
@AugustinMauroy
Copy link
Contributor Author

i had started to write a first draft.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Meta Issues for Administration of the Website Team
Projects
None yet
Development

No branches or pull requests

1 participant