content

This repository holds the written documentation, tutorials, FAQ entries, and blog posts for Graphcool, a backend service that helps developers build applications using GraphQL (a modern way for apps to request data from a server). Instead of being an application itself, this is the source content that powers the official documentation website at graph.cool/docs.

At a practical level, the repo is a collection of text files organized into folders by category — blog, FAQ, reference, and tutorial. Each article includes some metadata at the top (called "frontmatter") that tells the system what kind of article it is and how to display it. Contributors write in a simple text format and follow a few specific rules, like keeping descriptions under 160 characters and using a special linking system where articles are connected by short unique aliases rather than filenames.

The people who would use this repository are technical writers, developer advocates, and community contributors who want to help improve Graphcool's educational materials. For example, if a developer noticed that a tutorial had an outdated code sample or a missing step, they could fix it here. Or if the Graphcool team released a new feature, someone would add a reference article explaining how to use it. The content then gets published to the live docs site.

The project uses an automated system to verify changes before they go live, running checks on both the main and development branches. It has attracted a sizable community of contributors, with dozens of people credited for their help writing and maintaining articles over time.

Beyond the repo itself, Graphcool maintains a Slack channel and forum where users can ask questions and get help, which complements the more formal documentation stored here.