Contributing to Tyk documentation

This section provides resources and guidance for contributors to Tyk’s documentation. Whether you’re fixing a typo, adding new content, or helping improve our documentation standards, you’ll find the tools and guidelines you need here.

What this section covers

This contribution section includes:

• Inclusive naming - Information about Tyk’s inclusive language initiative and the work done to update documentation terminology
• UI component examples - Documentation and examples for using shortcodes in our documentation system:
  • Pill label shortcode - For labeling content with edition indicators (Enterprise, Cloud, Lab Release, etc.)
  • Feature cards shortcode - For creating responsive feature highlight grids
  • YouTube video embed shortcode - For embedding videos with proper styling and SEO

How to contribute to our docs

We appreciate any form of engagement and contribution to our documentation. You can contribute in several ways:

• Report an error in our GitHub repo
• Suggest/request an improvement in our GitHub repo
• Post a message in our community forum
• Update the code yourself:
  1. To find the page that needs editing in the GitHub repository, copy a sentence from the HTML page on the docs website and search for it using the GitHub search box in the top left corner of the repository
  2. Submit a PR directly to our docs repo. See our Guidelines for Pull Requests for detailed instructions.

Getting started with contributions

For detailed contribution guidelines, including pull request requirements, coding conventions, and technical guidance, please refer to our comprehensive CONTRIBUTING.md file in the repository.

Technical guidance

Our docs are compiled using the Hugo static site generator. For detailed technical guidance on creating and updating documentation pages, see the technical guide referenced in our CONTRIBUTING.md file.