Skip to content

Conversation

@avivkeller
Copy link
Member

Fixes #7836 by reorganizing our hard-to-navigate documentation files into a focused, well-structured docs/ directory.

New Files (excluding moved files)

docs/
├── README.md              # Navigation guide
├── getting-started.md     # Development setup and first contribution
├── code-style.md          # Coding standards and formatting
├── adding-pages.md        # Page and content creation
├── creating-components.md # React component development
├── writing-tests.md       # Testing guidelines (unit, E2E, Storybook)
├── technologies.md        # Tech stack and architecture decisions
├── downloads-page.md      # Installation methods and package managers
├── package-publishing.md  # Publishing workflow for monorepo packages
└── collaborator-guide.md  # Collaborator-specific guidelines

@canerakdas I didn't update the Downloads Page guidelines with the most recent information - feel free to push directly to this branch to bring those sections up to date.

Copilot AI review requested due to automatic review settings June 4, 2025 22:56
@avivkeller avivkeller requested a review from a team as a code owner June 4, 2025 22:56
@vercel
Copy link

vercel bot commented Jun 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Jun 5, 2025 1:37pm

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR restructures project documentation into a centralized docs/ folder and introduces focused guides for contributors and maintainers.

  • Adds new how-to guides covering setup, coding style, testing, architecture, publishing, and collaborator workflows
  • Provides a navigation README and reorganizes existing scattered docs into a clear directory
  • Standardizes linking and table of contents across markdown files

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/writing-tests.md Adds a comprehensive testing guide with unit, E2E, and visual testing sections
docs/technologies.md Introduces a deep dive into tech stack, architecture, and repo structure
docs/package-publishing.md Describes the monorepo package publishing workflow with CI integration
docs/getting-started.md New developer onboarding guide with environment setup and first contribution steps
docs/downloads-page.md Instructions for extending the Node.js downloads page with methods and package managers
docs/collaborator-guide.md Outlines responsibilities, PR policies, and collaborator onboarding/maintenance
docs/code-style.md Establishes coding standards, import rules, and commit message conventions
docs/adding-pages.md Details content creation process, frontmatter, navigation updates, and i18n
docs/README.md Navigation hub for all docs in the docs/ folder
Comments suppressed due to low confidence (5)

docs/README.md:30

  • The link to translation.md points to a file that was not added in this PR. Please add translation.md or remove/update the link.
- [Translation Guidelines](./translation.md) - Website translation policy

docs/README.md:31

  • The link to dependency-pinning.md points to a file that is missing from the docs/ directory. Please include the file or correct the reference.
- [Dependency Pinning](./dependency-pinning.md) - Package management guidelines

docs/getting-started.md:73

  • The anchor #structure-of-this-repository does not match the actual heading ## Repository Structure. Update the link to #repository-structure.
- For repository structure guidance, see [Technologies](./technologies.md#structure-of-this-repository)

docs/adding-pages.md:76

  • [nitpick] The path components/withLayout is ambiguous. Consider specifying the full path (apps/site/components/withLayout.tsx) for clarity.
> **Note**: Layout components are currently mapped in `components/withLayout`. This location may change in future updates.

docs/adding-pages.md:83

  • The path app/site/navigation.json seems to have a typo—it should be apps/site/navigation.json.
- Learn section: Update `app/site/navigation.json`

@codecov
Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.47%. Comparing base (2054bcc) to head (2245804).
Report is 13 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7837      +/-   ##
==========================================
- Coverage   75.49%   75.47%   -0.03%     
==========================================
  Files         101      101              
  Lines        8309     8309              
  Branches      218      218              
==========================================
- Hits         6273     6271       -2     
- Misses       2034     2036       +2     
  Partials        2        2              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@avivkeller
Copy link
Member Author

Thus, like our old files, uses Capitally Cased headers.

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went over 80% of it, but looks good. New good additions and a nice structure :)

@avivkeller avivkeller added the github_actions:pull-request Trigger Pull Request Checks label Jun 8, 2025
@avivkeller avivkeller enabled auto-merge June 8, 2025 18:06
@avivkeller avivkeller disabled auto-merge June 8, 2025 18:06
@github-actions github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Jun 8, 2025
@avivkeller
Copy link
Member Author

Feel free to merge when you think this is good to go.

@github-actions
Copy link
Contributor

github-actions bot commented Jun 8, 2025

Lighthouse Results

URL Performance Accessibility Best Practices SEO Report
/en 🟢 98 🟢 100 🟢 100 🟢 91 🔗
/en/about 🟢 100 🟢 100 🟢 100 🟠 82 🔗
/en/about/previous-releases 🟢 99 🟢 100 🟢 100 🟠 83 🔗
/en/download 🟢 98 🟢 100 🟢 100 🟢 91 🔗
/en/blog 🟢 100 🟢 100 🟢 96 🟢 92 🔗

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT ! I'm not good writer so nothing to say more

@avivkeller avivkeller added this pull request to the merge queue Jun 8, 2025
Merged via the queue into main with commit 3d565a4 Jun 8, 2025
15 checks passed
@avivkeller avivkeller deleted the chore/docs-folder branch June 8, 2025 20:52
@kimpuro kimpuro mentioned this pull request Jun 11, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorganize documentation structure (CONTRIBUTING.md vs COLLABORATOR_GUIDE.md)

4 participants