Skip to content

Update README to improve clarity and add missing sections #1823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 21, 2024

Conversation

shashankrushiya
Copy link
Contributor

Closes #

Description

Title: Improve README Documentation and Structure

Description:
This PR enhances the readability and structure of the README.md file for the GraphQL website repository. The changes aim to make the documentation more user-friendly and accessible, particularly for new contributors. Below is a summary of the improvements:

  • Table of Contents: Added to improve navigation within the README.
  • Overview Section: Rephrased for clarity, explaining GraphQL's purpose more effectively.
  • Deployment Instructions: Expanded with steps for running the site locally.
  • Contribution Guidelines: Organized the CLA process steps for easier comprehension.
  • Financial Support: Added details on supporting the GraphQL Foundation.

These updates help streamline the onboarding process for contributors and provide a clearer understanding of the project and its goals.

Type of change:

  • Documentation enhancement

Checklist:

  • I've read the contributing guidelines
  • My changes improve the documentation structure and clarity
  • I’ve tested the deployment instructions locally

Copy link

linux-foundation-easycla bot commented Nov 12, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link

vercel bot commented Nov 12, 2024

@shashankrushiya is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

Thanks; these changes look good! I've suggested a few edits below

Copy link

vercel bot commented Nov 21, 2024

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

Name Status Preview Comments Updated (UTC)
graphql-github-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 2:29pm

@benjie benjie merged commit fcceffc into graphql:source Nov 21, 2024
2 of 3 checks passed
@shashankrushiya
Copy link
Contributor Author

Hi @benjie, thank you for implementing the changes; they look great!

@shashankrushiya shashankrushiya deleted the update-readme branch November 21, 2024 16:10
mandiwise pushed a commit to mandiwise/graphql.github.io that referenced this pull request Nov 22, 2024
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.

2 participants