You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improvements: Typos and grammatical errors in README.md (#1081)
* Improved README.md
Fixed some typos, grammatical errors and added extra info in places for extra clarity
* Replaced word to suggestion
Co-authored-by: Dhairya Majmudar <[email protected]>
* Update README.md
* Update README.md
Co-authored-by: Greg Dennis <[email protected]>
* Update README.md
Co-authored-by: Greg Dennis <[email protected]>
* Resolved benjam's review
* Small Tweaks to README.md to improve clarity
---------
Co-authored-by: Dhairya Majmudar <[email protected]>
Co-authored-by: Greg Dennis <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+28-26
Original file line number
Diff line number
Diff line change
@@ -20,15 +20,15 @@
20
20
</p>
21
21
22
22
# 👋 Welcome to the JSON Schema website
23
-
This repository contains the sources of JSON Schema website:
23
+
This repository contains the source code of the JSON Schema website:
24
24
25
-
*It's powered by Next.js,
26
-
*It uses Tailwind CSS framework,
27
-
*It's build and deployed with Netlify.
25
+
*Powered by Next.js,
26
+
*Uses the Tailwind CSS framework,
27
+
*Built and deployed with Netlify.
28
28
29
-
## Setting up Project
29
+
## Setting up the Project
30
30
31
-
Please refer to the [INSTALLATION.md](./INSTALLATION.md)file for instructions on how to set up the project on your local machine.
31
+
Please refer to [INSTALLATION.md](./INSTALLATION.md) for instructions on how to set up the project for local development.
32
32
33
33
## Project structure
34
34
@@ -37,41 +37,42 @@ This repository has the following structure:
37
37
<!-- If you make any changes in the project structure, remember to update it. -->
38
38
39
39
```text
40
-
├── .github # Definitions of GitHub workflows, pull request and issue templates
40
+
├── .github # Definitions of GitHub workflows, pull request, and issue templates
41
41
├── components # Various generic components such as "Button", "Figure", etc.
42
-
├── data # JSON Schema Implementations.
42
+
├── data # JSON Schema implementations
43
43
├── styles # Various CSS files
44
-
├── lib # Various JS code for preparing static data to render in pages
45
-
├── pages # Website's pages source. It includes raw markdown files and React page templates.
44
+
├── lib # Various JS code for preparing static data to render on pages
45
+
├── pages # Website's pages source, including raw markdown files and React page templates
46
46
│ ├── overview # JSON Schema initiative docs
47
47
│ ├── blog # Blog posts
48
48
│ ├── learn # JSON Schema docs
49
49
│ └── implementations # Various pages to describe tools
50
-
├── public # Data for site metadata and static blog such as images
50
+
├── public # Data for site metadata and static assets such as images
51
51
├── next.config.js # Next.js configuration file
52
52
53
53
```
54
54
55
55
## Contribute
56
-
57
56
Here are some areas where you can contribute to the website:
58
-
- Blogs posts
59
-
- Case Studies
57
+
58
+
- Blog posts
59
+
- Case studies
60
60
- Design
61
-
- Documentation
61
+
- Documentation improvements
62
62
- Website enhancements
63
-
- Add a new JSON Schema Implementation
63
+
- Add a new JSON Schema implementation
64
64
- JSON Schema Landscape
65
65
66
-
To figure out a good first issue to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
66
+
To identify good first issues to work on, join our Slack workspace and visit the `#contribute` channel. This channel is specifically designed for onboarding and supporting new contributors.
67
67
68
68
You should also check out our [Contributing guidelines](./CONTRIBUTING.md).
69
69
70
70
### Contributors
71
71
72
-
Thanks goes to these wonderful people who contributed to this website:
0 commit comments