chore(meta): docs folder #7837
Open
chore(meta): docs folder #7837
+2,188
−1,013
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
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.mdpoints to a file that was not added in this PR. Please addtranslation.mdor remove/update the link.
- [Translation Guidelines](./translation.md) - Website translation policy
docs/README.md:31
- The link to
dependency-pinning.mdpoints to a file that is missing from thedocs/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-repositorydoes 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/withLayoutis 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.jsonseems to have a typo—it should beapps/site/navigation.json.
- Learn section: Update `app/site/navigation.json`
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ 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. |
|
Thus, like our old files, uses Capitally Cased headers. |
avivkeller
force-pushed
the
chore/docs-folder
branch
from
eeb801c to
2245804
Compare
ovflowd
approved these changes
Jun 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7836 by reorganizing our hard-to-navigate documentation files into a focused, well-structured
docs/directory.New Files (excluding moved files)
@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.