Skip to content

Commit 5e23aed

Browse files
committed
Merge branch 'source' into oneof-post
2 parents 7f32a5a + 71b97cb commit 5e23aed

File tree

822 files changed

+24097
-11587
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

822 files changed

+24097
-11587
lines changed

.eslintrc.cjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ module.exports = {
109109
rules: {
110110
"mdx/remark": "error",
111111
"no-unused-expressions": "off",
112+
"react/jsx-no-undef": "off",
112113
},
113114
},
114115
{

.github/workflows/check.yml

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Lint and check formatting
33
on: pull_request
44

55
jobs:
6-
prettier-check:
6+
check:
77
runs-on: ubuntu-latest
88
steps:
99
- uses: actions/checkout@v4
@@ -22,3 +22,22 @@ jobs:
2222

2323
- name: Run Prettier Check
2424
run: pnpm format:check
25+
26+
- name: Validate code snippets
27+
run: pnpm validate:snippets
28+
29+
# per the docs: "caching browser binaries is not recommended,
30+
# since the amount of time it takes to restore the cache is
31+
# comparable to the time it takes to download the binaries"
32+
- name: Install Playwright Browsers
33+
run: npx playwright install --with-deps
34+
35+
- name: Run Playwright tests
36+
run: npx playwright test
37+
38+
- uses: actions/upload-artifact@v4
39+
if: ${{ !cancelled() }}
40+
with:
41+
name: playwright-report
42+
path: playwright-report/
43+
retention-days: 30

.github/workflows/docs-validation.yml

Lines changed: 0 additions & 64 deletions
This file was deleted.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,5 @@ public/sitemap.xml
6363
out/
6464

6565
tsconfig.tsbuildinfo
66+
67+
playwright-report/

.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ pnpm-lock.yaml
44
!src/pages/blog/2024-04-11-announcing-new-graphql-website/index.mdx
55
!src/pages/blog/2024-08-15-graphql-local-initiative.mdx
66
!src/pages/community/foundation/community-grant.mdx
7-
!src/pages/blog/2025-06-01-graphiql-4/index.mdx
7+
!src/pages/blog/2025-05-31-graphiql-4/index.mdx
8+
!src/pages/blog/2025-06-10-graphiql-5/index.mdx
89
!src/pages/blog/2025-06-19-multioption-inputs-with-oneof/index.mdx
910
*.jpg
1011

.vscode/settings.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,11 @@
99
"[typescript]": {
1010
"editor.defaultFormatter": "esbenp.prettier-vscode"
1111
},
12-
"tailwindCSS.classFunctions": ["clsx"]
12+
"tailwindCSS.classFunctions": ["clsx"],
13+
"editor.quickSuggestions": {
14+
"strings": "on"
15+
},
16+
"typescript.preferences.autoImportFileExcludePatterns": [
17+
"**/node_modules/lucide-react"
18+
]
1319
}

BLOG_STYLE_GUIDE.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# BLOG_STYLE_GUIDE.md
2+
3+
## GraphQL Blog Content Style Guide
4+
5+
Welcome to the GraphQL Blog Style Guide! This document outlines best practices and standards for writing engaging, informative, and technically accurate content for our audience.
6+
7+
---
8+
9+
## ✍️ General Writing Principles
10+
11+
- **Audience First**: Think about who the audience of your post is.
12+
- **Clarity is Key**: Prioritize clear, concise explanations over jargon. Break down complex ideas with examples.
13+
- **Vendor neutral**: The GraphQL Blog is about GraphQL as a technology. Vendor specific content and personal promotion doesn't belong in the GraphQL blog.
14+
15+
## ℹ️ Content
16+
17+
The GraphQL blog welcomes contributions. Anyone may submit a blog post idea by [opening an issue](https://github.com/graphql/graphql.github.io/issues/new) or a draft by [opening a pull request](https://github.com/graphql/graphql.github.io/pulls).
18+
19+
Maintainers are responsible for approving and merging the pull requests.
20+
When merging a blog post, they should also schedule an announcement on our social channels (at time of writing this is managed via [Typefully](https://typefully.com)).
21+
22+
Example content:
23+
24+
- Announcements: events, new versions of [GraphQL tools or specifications](https://github.com/orgs/graphql/repositories), updates about the GraphQL foundation, collaborations, etc...
25+
- Best practices: share learnings and make the best of GraphQL.
26+
- Case studies: explain how GraphQL helped solve a problem.
27+
- Technical updates: broadcast an update about discussions happening in a working group.
28+
- etc...
29+
30+
This list is non-exhaustive. If there is something you would like to see on the GraphQL blog, [open an issue for discussion](https://github.com/graphql/graphql.github.io/issues/new).
31+
32+
---
33+
34+
## 📚 Structure
35+
36+
### Title
37+
38+
- Clear, concise, and descriptive.
39+
- Avoid clickbait. Example:
40+
✅ "Understanding GraphQL Subscriptions"
41+
❌ "This One GraphQL Trick Will Blow Your Mind"
42+
43+
### Introduction
44+
45+
- Hook the reader in 1–2 sentences.
46+
- Set clear expectations about what the post covers and who it's for:
47+
- open source users of a given project (release notes, updates,...) are probably already familiar with the tool.
48+
- technical users (best practices, working group updates) have a technical background but may be new to GraphQL concepts.
49+
- larger audience (case studies, events, grants, reports) may not necessarily have a technical background but still be interested in latest GraphQL content.
50+
51+
### Body
52+
53+
- Use clear headers (`##`, `###`) to organize sections.
54+
- Limit paragraphs to 3–5 sentences.
55+
- Use bullet points or numbered lists for step-by-step content.
56+
- Include **code samples** where relevant.
57+
- Use callouts for **tips**, **warnings**, or **best practices**.
58+
59+
### Conclusion
60+
61+
- Summarize key takeaways.
62+
- Link to related resources, docs, or posts.
63+
- Include a call to action if applicable (e.g., "Try it out", "Join the discussion").
64+
65+
---
66+
67+
## ✅ Do
68+
69+
- Cite sources if you reference third-party tools or documentation.
70+
- Use inclusive language: prefer "you/the user" over gendered or assumptive terms.
71+
- Use present tense.
72+
73+
## ❌ Don't
74+
75+
- Don’t assume the reader knows your stack.
76+
- Don't overuse metaphors; use them sparingly to aid understanding.
77+
- Don't overuse passive voice. Active voice often brings more clarity.
78+
- Don't overuse future tense. The present tense often brings more clarity.
79+
80+
---
81+
82+
Thank you for contributing to the GraphQL Blog! 🎉

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ There are many ways to get involved. Follow this guide and feel free to [reach o
2020
- [Add a resource to the Community page](#add-a-resource-to-the-community-page)
2121
- [Add a question to the FAQ](#add-a-question-to-the-faq)
2222
- [Write a new section or guide](#write-a-new-section-or-guide)
23+
- [Add a blog post](#add-a-blog-post)
2324
- [Making changes to the code](#making-changes-to-the-code)
2425
- [Browser support](#browser-support)
2526
- [Contributing something else](#contributing-something-else)
@@ -149,6 +150,12 @@ Then, use our [development guide](#development-guide) to determine where your ne
149150

150151
Once it's ready for review, please [open a pull request](https://github.com/graphql/graphql.github.io/pulls).
151152

153+
### Add a blog post
154+
155+
This repository holds the [graphql.org blog](https://graphql.org/blog/) at [source/src/pages/blog](https://github.com/graphql/graphql.github.io/tree/source/src/pages/blog). Blog posts may contain announcements, news, best practices and more.
156+
157+
Contributions are very welcome! Please see the [BLOG_STYLE_GUIDE](BLOG_STYLE_GUIDE.md) for more information.
158+
152159
## Making changes to the code
153160

154161
Before diving into any code updates, please [open an issue](https://github.com/graphql/graphql.github.io/issues/new) describing the change(s) you'd like to make.

0 commit comments

Comments
 (0)