Internal Documentation
Menu

Site Usage & Technical Guides

Last updated: Sep-04-2025

Caution
These docs are strictly for internal use only. They are only present in the development (docs-dev) and staging domains. There should be no external links to these pages, and links to these pages should not be shared externally.

Overview

This section contains essential technical knowledge for working with our documentation site project. These guides cover the specialized tools, syntax, and procedures specific to maintaining and enhancing our documentation website.

Important

This section focuses specifically on the technical aspects of our documentation site project. For general content creation guidelines and writing standards, see Documentation Standards.

On this page:

Guide Overview

  • Dev Environment Setup Guide includes:

    • Prerequisites - Repository setup, SSH keys, VPN access, and tool requirements
    • Docker Setup - Recommended containerized environment with installation and configuration
    • Local Machine Setup - Alternative Ruby/Rails development environment setup
    • Maintenance Tasks - Ruby version upgrades, content renderer updates, and helpful aliases
    • Static Content Generation - Testing full site generation and viewing static files locally
    • Troubleshooting - Common setup issues and resolution steps

  • Custom Markdown Syntax includes:

    • Transformation Widgets - Interactive code examples with SDK tabs
    • Styled Boxes - Notes, tips, warnings, and information boxes
    • Multi-Code Widgets - Manual code examples with multiple language tabs
    • Partials and Variables - Reusable content snippets and dynamic text
    • Video Players - Embedded Cloudinary video players with custom configuration

  • Adding Documentation Pages includes:

    • File Creation - Proper structure and naming conventions
    • Menu Configuration - Navigation setup and hierarchy management
    • Metadata Setup - Titles, descriptions, and SEO configuration
    • Homepage Integration - Adding to popular topics and what's new sections
    • Testing Procedures - Validation and quality assurance steps

  • Release Notes Management includes:

    • File Structure - Main files, archives, and content partials
    • Creation Process - Step-by-step release notes workflow
    • Content Guidelines - Writing standards for release announcements
    • RSS Management - Feed updates and syndication
    • Testing and Validation - Quality checks before publication

  • Site Troubleshooting includes:

    • Server and Development Issues - Local development problems
    • Content Renderer Issues - Code widget and transformation problems
    • Menu and Navigation Issues - TOC and site navigation fixes
    • Repository Management - Git workflows and cleanup procedures
    • Performance and Monitoring - Site optimization and maintenance

  • Code Widget Testing Guide includes:

    • Setup and Testing Workflow - Prerequisites and recommended testing process for renderer validation
    • Transformation Types - Video, audio, 3D models, conditional processing, variables, and arithmetic operations
    • Widget UI Configuration - Embedded image control, tab visibility, framework selection, and thumbnail settings
    • Account-Specific Behavior - Demo vs non-demo account defaults and override configurations
    • Multi Widget Examples - Manual code specification across multiple SDKs and use cases
    • Testing Checklist - Comprehensive validation steps for code widget functionality
    • Known Issues - Current limitations and bugs in the content renderer system

✔️ Feedback sent!

Rate this page: