update Readme.md and Contributing.md for branching strategies and folder structure#9
update Readme.md and Contributing.md for branching strategies and folder structure#9arribion-link merged 4 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request significantly enhances the contributor documentation by introducing a structured learning path, detailed workflow guidelines, and comprehensive contribution standards. The updates transform basic documentation into a well-organized system that guides contributors through proper branching, commit conventions, and content creation processes.
- Introduces progressive documentation structure with numbered learning paths from beginner to advanced levels
- Establishes comprehensive contribution workflow including forking, branching conventions, and pull request guidelines
- Adds detailed content guidelines, file structure templates, and quality standards for new documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| Readme.md | Restructures documentation with progressive learning paths, adds comprehensive contributor onboarding workflow, and expands content guidelines with detailed templates |
| CONTRIBUTING.md | Introduces branch naming conventions, commit message standards, detailed folder structure, and comprehensive review process guidelines |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ├── 🚀 getting-started.md # Start your journey here | ||
| ├── 📄 intro.md # Project overview | ||
| │ | ||
| ├── 🟨 Javascript/ # JavaScript Documentation |
There was a problem hiding this comment.
The folder name should be 'JavaScript' with a capital 'S' to match standard capitalization conventions for the language name.
| ├── 🟨 Javascript/ # JavaScript Documentation | |
| ├── 🟨 JavaScript/ # JavaScript Documentation |
| │ ├── error-handling.md # 12. Handling errors | ||
| │ └── final-projects.md # 13. Capstone projects | ||
| │ | ||
| ├── 🔷 Typescript/ # TypeScript Documentation (After JS Intermediate) |
There was a problem hiding this comment.
The folder name should be 'TypeScript' with a capital 'S' to match the official TypeScript branding and capitalization.
| ├── 🔷 Typescript/ # TypeScript Documentation (After JS Intermediate) | |
| ├── 🔷 TypeScript/ # TypeScript Documentation (After JS Intermediate) |
| ├── getting-started.md # Getting started guide | ||
| ├── intro.md # Project overview | ||
| │ | ||
| ├── Javascript/ # JavaScript documentation |
There was a problem hiding this comment.
The folder name should be 'JavaScript' with a capital 'S' to match standard capitalization conventions for the language name.
| ├── Javascript/ # JavaScript documentation | |
| ├── JavaScript/ # JavaScript documentation |
| │ ├── error-handling.md # Error handling patterns | ||
| │ └── final-projects.md # Intermediate projects | ||
| │ | ||
| ├── Typescript/ # TypeScript documentation |
There was a problem hiding this comment.
The folder name should be 'TypeScript' with a capital 'S' to match the official TypeScript branding and capitalization.
| ├── Typescript/ # TypeScript documentation | |
| ├── TypeScript/ # TypeScript documentation |
Deploying nuvex-docs with
|
| Latest commit: |
ec46960
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2b037285.nuvex-docs.pages.dev |
| Branch Preview URL: | https://staging.nuvex-docs.pages.dev |
This pull request significantly enhances the project's contributor documentation by introducing clearer structure, detailed workflow guidelines, and improved onboarding instructions. The main updates include a reorganized documentation structure for progressive learning, explicit branch and commit conventions, a revamped contribution workflow, and expanded content guidelines to ensure consistency and quality.
Documentation structure and learning path:
CONTRIBUTING.mdandReadme.mdto describe a progressive, step-by-step documentation structure, including detailed folder organization and suggested learning paths for users at different skill levels. [1] [2]Contribution workflow and onboarding:
Branching and commit conventions:
Content and style guidelines:
Improved issue reporting and review process: