Skip to content

update Readme.md and Contributing.md for branching strategies and folder structure#9

Merged
arribion-link merged 4 commits intomainfrom
staging
Oct 5, 2025
Merged

update Readme.md and Contributing.md for branching strategies and folder structure#9
arribion-link merged 4 commits intomainfrom
staging

Conversation

@sammy6378
Copy link
Copy Markdown
Owner

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:

  • Updated both CONTRIBUTING.md and Readme.md to 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:

  • Added comprehensive instructions for forking, branching, syncing, making changes, and submitting pull requests, including a step-by-step workflow for new contributors.

Branching and commit conventions:

  • Introduced branch naming conventions and commit message guidelines, with clear examples and a checklist to ensure consistency and clarity in contributions.

Content and style guidelines:

  • Expanded and clarified content guidelines, including requirements for beginner-friendly writing, code example standards, content structure, and prohibited content.

Improved issue reporting and review process:

  • Added detailed instructions for reporting issues, using templates, and following a structured review process to streamline collaboration and feedback. [1] [2]

@sammy6378 sammy6378 self-assigned this Sep 3, 2025
Copilot AI review requested due to automatic review settings September 3, 2025 09:28
@sammy6378 sammy6378 added the content-update update the existing content label Sep 3, 2025
Copy link
Copy Markdown
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 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
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The folder name should be 'JavaScript' with a capital 'S' to match standard capitalization conventions for the language name.

Suggested change
├── 🟨 Javascript/ # JavaScript Documentation
├── 🟨 JavaScript/ # JavaScript Documentation

Copilot uses AI. Check for mistakes.
│ ├── error-handling.md # 12. Handling errors
│ └── final-projects.md # 13. Capstone projects
├── 🔷 Typescript/ # TypeScript Documentation (After JS Intermediate)
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The folder name should be 'TypeScript' with a capital 'S' to match the official TypeScript branding and capitalization.

Suggested change
├── 🔷 Typescript/ # TypeScript Documentation (After JS Intermediate)
├── 🔷 TypeScript/ # TypeScript Documentation (After JS Intermediate)

Copilot uses AI. Check for mistakes.
├── getting-started.md # Getting started guide
├── intro.md # Project overview
├── Javascript/ # JavaScript documentation
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The folder name should be 'JavaScript' with a capital 'S' to match standard capitalization conventions for the language name.

Suggested change
├── Javascript/ # JavaScript documentation
├── JavaScript/ # JavaScript documentation

Copilot uses AI. Check for mistakes.
│ ├── error-handling.md # Error handling patterns
│ └── final-projects.md # Intermediate projects
├── Typescript/ # TypeScript documentation
Copy link

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

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

The folder name should be 'TypeScript' with a capital 'S' to match the official TypeScript branding and capitalization.

Suggested change
├── Typescript/ # TypeScript documentation
├── TypeScript/ # TypeScript documentation

Copilot uses AI. Check for mistakes.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying nuvex-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ec46960
Status: ✅  Deploy successful!
Preview URL: https://2b037285.nuvex-docs.pages.dev
Branch Preview URL: https://staging.nuvex-docs.pages.dev

View logs

@arribion-link arribion-link merged commit c69444f into main Oct 5, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content-update update the existing content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants