Skip to content

[📝 Docs]: Enhance the Contribution Docs Guide for Better Readability and Structure #1124

Open
@fee-sah-yor

Description

@fee-sah-yor

What Docs changes are you proposing?

Description:

Hi, I read through the contribution guide and noticed that some parts of the introduction can be a bit confusing, especially for beginners. I found myself rereading certain sections multiple times to fully understand the process. Here are a few suggestions to improve the guide’s clarity:

  1. Reorder Items in "Before You Start":

    • I suggest moving "Read the style guide" to the third item in the "Before You Start" list. This way, beginners can go through the style guide first, and then proceed to fork the JSON schema repo. This feels more intuitive.
      Reword Installation Instructions:
  2. Reword Installation Instructions:

    • The line "Install the JSON schema website on your computer" could be rephrased to:
      "Fork the repo and follow these steps to install the JSON schema website on your computer."
      This change better reflects the steps outlined later in the guide, particularly in the "Work on an Existing Issue" section.
  3. Format the "Work on an Existing Issue" Section:

    • The instructions in this section could be formatted as a bulleted list with indented steps for better readability. It’s currently harder to follow as a block of text.

i believe these changes as well as others will help beginner contributors interacting with the guide for the first time understand it better.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

Labels

Status: In ProgressThis issue is being worked on, and has someone assigned.📝 DocumentationIndicates improvements or additions to documentation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions