Skip to content

Commit bb4ee0d

Browse files
authored
Apply suggestions from code review
1 parent 689d71e commit bb4ee0d

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,35 @@ You can find more discussions on the [#website channel on the GraphQL Slack](htt
1616
## Overview
1717

1818
**GraphQL** is a query language for APIs and a runtime for fulfilling those queries with your existing data. It provides:
19-
- A complete and understandable description of the data in your API.
20-
- The ability for clients to ask for exactly what they need.
21-
- Powerful developer tools.
19+
20+
- a complete and understandable description of the data in your API,
21+
- support for powerful developer tooling, and
22+
- precise querying, which offers several benefits:
23+
- clients request only the data they need, improving efficiency;
24+
- new fields and features can be added without impacting existing clients; and
25+
- field-level usage can be tracked and monitored for insights and optimization.
2226

2327
The [GraphQL Specification](https://spec.graphql.org/) is open source and governed by the [GraphQL Foundation](https://foundation.graphql.org/).
2428

2529
## Documentation
2630

2731
- [GraphQL Website](https://graphql.org/)
28-
- [Reference Documentation](https://graphql.org/learn/) - Detailed guides and tutorials.
29-
- [Language Support, Tools, and Services](https://graphql.org/code/) - Available tools and libraries for different languages.
30-
- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/) - Answers to common questions.
31-
- [Community Resources](https://graphql.org/community/) - Community-driven resources.
32+
- [Reference Documentation](https://graphql.org/learn/)
33+
- [Language Support, Tools, and Services](https://graphql.org/code/)
34+
- [Frequently Asked Questions (FAQ)](https://graphql.org/faq/)
35+
- [Community Resources](https://graphql.org/community/)
3236

3337
## Deployment
3438

3539
The website is deployed via [Vercel](https://vercel.com) on merges to the `source` branch. To preview changes locally, follow these steps:
40+
3641
1. Clone the repository:
37-
`git clone https://github.com/graphql/graphql.github.io.git`
42+
`git clone https://github.com/graphql/graphql.github.io.git`
43+
`cd graphql.github.io`
3844
2. Install dependencies:
3945
`npm install`
4046
3. Run the site locally:
41-
`npm start`
47+
`npm run dev`
4248

4349
## How to Contribute
4450

@@ -47,13 +53,14 @@ We welcome contributions! 🎉 Please refer to our [contributing guide](./CONTRI
4753
### CLA Process
4854

4955
Before contributing, all participants must sign the free [GraphQL Specification Membership Agreement](https://preview-spec-membership.graphql.org). You only need to do this once, and it can be signed by:
56+
5057
- [Individual contributors](http://individual-spec-membership.graphql.org/)
5158
- [Employers](http://corporate-spec-membership.graphql.org/)
5259

5360
To initiate the signature process, please open a PR against this repository. The EasyCLA bot will block the merge if the membership agreement has not been signed.
5461

5562
For more information on the CLA, check out the [detailed instructions here](https://github.com/graphql/graphql-wg/tree/main/membership). If you encounter any issues, please contact us at [operations@graphql.org](mailto:operations@graphql.org).
5663

57-
## Financial Support
64+
## Join the Foundation!
5865

5966
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please consider becoming a member of the [GraphQL Foundation](https://foundation.graphql.org/join).

0 commit comments

Comments
 (0)