Node.js Website Documentation

This directory contains documentation for contributing to the Node.js website project.

Getting Started

New to contributing? Start here:

• Getting Started - Set up your development environment and make your first contribution
• Adding Pages - Learn how to create new pages and content

Development Guidelines

• Code Style - Coding standards and formatting guidelines
• Creating Components - Best practices for React component development
• Writing Tests - Testing guidelines for unit tests, E2E tests, and Storybooks

Technical Documentation

• Technologies - Overview of the tech stack and architecture decisions
• Site Configuration - How to update site.json (banners, badges, RSS feeds, metadata)
• Downloads Page - How to add installation methods and package managers
• Package Publishing - Guidelines for publishing packages in our monorepo
• Cloudflare build and deployment - Overview and useful information about the Cloudflare build and deployment

For Collaborators

• Collaborator Guide - Guidelines specific to project collaborators with write access

Additional Resources

• Translation Guidelines - Website translation policy
• Dependency Pinning - Package management guidelines
• Code of Conduct - Rules for respectful participation in the community

Quick Reference

• Repository Structure: See Technologies
• Component Guidelines: See Creating Components
• Commit Guidelines: See Code Style
• Pull Request Policy: See Collaborator Guide