GraphQL Foundation Handbooks

This repository contains community-maintained documentation and guides for
various GraphQL Foundation processes and programs. Contributions are very
welcome, and should follow the
Contributing Handbook!

Structure

• docs/contributing — Contributing to GraphQL Foundation projects via GitHub.
• docs/wg — Meeting participation and facilitation guides.
• docs/ambassadors — Expectations, enablement, and standards for GraphQL
  Ambassadors.
• docs/social-media — Campaign workflows and brand guidelines for the social
  team.
• docs/locals — Launching and scaling local GraphQL communities.
• docs/grants — Community grant preparation and reporting.
• docs/tsc — Technical Steering Committee processes.

Each page should start with an outline of the target audience for the article,
enabling readers to skip articles that do not match their current goals.

Getting Started

1. Ensure you have Node.js 22+ installed (e.g. with nvm install 22)
2. Ensure you have yarn installed (e.g. with npm install -g yarn)
3. Check out the repository (e.g. with
   git checkout https://github.com/graphql/handbooks)
4. Change into that repository (e.g. cd handbooks)
5. Install the dependencies with yarn

yarn

Local Development

yarn start

This command runs the development server. The site will reload as you edit
files.

Build for Production

yarn build

The static assets are output to the build directory and can be served by any
static hosting platform. Test it locally:

yarn serve

Configuration

• Update site metadata in docusaurus.config.ts (url, navigation, footer).
• Manage sidebar structure in sidebars.ts.
• Customize styling in src/css/custom.css.

Formatting

This project uses Prettier to keep Markdown, MDX, and
source files wrapped to a consistent line length.

• Format files automatically:

  yarn format
  

• Check formatting without applying changes:

  yarn format:check
  

Editor integration

If you use VS Code, install the “Prettier – Code formatter” extension and add
the following to .vscode/settings.json to format on save:

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "[markdown]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[mdx]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

Contributing

1. Fork the repository.
2. Check out your fork.
3. Create a new branch.
4. Make your updates.
5. Run yarn format to fix formatting.
6. Run yarn build to verify the site compiles.
7. Push your changes and open a pull request, include a description.