Contributing to documentation

This documentation serves as a comprehensive guide to help you navigate and contribute to the Stride Docs website.

If you're looking to make minor changes, such as adding or updating a manual, tutorial or page, or fixing a typo, feel free to jump straight to the Content Updates section.

For more extensive updates 🤯🤦‍♂️ or for a deeper understanding of the docs website project, we recommend exploring all the sections provided. Happy browsing and contributing!

Here are the technologies we use to build our website:

• docfx (static site generator)
• Markdown
• Mustache template engine (docfx dropped Liquid template engine support)
• Bootstrap
• Emojis (because why not? 😎)
• HTML, JavaScript, CSS, JSON
• PowerShell scripts
• GitHub Actions (CI/CD) - Don't worry, this is already set up, you don't need to worry about it.

Table of Contents

• Understanding the Stride Documentation Generation Pipeline
  • Introduction
  • A Simplified Overview
  • Docs Build Workflow
  • Workflow Diagram
• Installation
  • Prerequisites
  • Installation Steps
  • Running the Development Server
• Content Updates
  • Small Updates
  • Major Updates
  • Manual
    • Creating New Page
  • Tutorial
    • Creating New Tutorial
  • Shortcodes and Includes
    • Alert
    • Video
  • Web Assets
  • Styling
    • Bootstrap Customization
    • CSS Guidelines
  • Submitting your Changes
• New Language
  • Adding a New Language
• Roadmap
• DocFX
  • Packages and Dependencies
  • Configuration
  • Global Data
  • Folder Structure
  • Layouts
  • Includes
  • Advanced Topics
    • Creating Custom Shortcodes and Includes
• Deployment
  • GitHub Pages
  • Azure Web Apps
• Troubleshooting and FAQ
  • Known Issues
  • Common Issues and Solutions
  • Frequently Asked Questions