Home

Welcome to the Chainguard Academy wiki. This section of the edu repo is where we maintain the Chainguard Academy Style Guide, along with other resources for producing high-quality docs.

Our goal for this wiki is that it will assist Chainguard's employees, customers, and users with producing and maintaining technical educational content that shares a consistent voice and meets the level of detail and technical accuracy expected of our documentation and educational resources.

This wiki provides a single source of truth for the most common questions that come up when drafting and revising technical educational resources. Be aware that there is no singular “correct” approach to writing; our hope is that these practices and techniques will help you achieve a high level of clarity and teaching effectiveness.

We expect these guidelines to evolve over time, so feedback is welcome!