Documentation Guide

Welcome to the Docusaurus Status Plugin (Stentorosaur) documentation! This guide will help you find the information you need.

🚀 Quick Start

New to Stentorosaur? Start here:

1. README.md - Project overview, features, and installation
2. QUICKSTART.md - Get your status page running in 5 minutes
3. CONTRIBUTING.md - Want to contribute? Start here

📚 Documentation Structure

Root-Level Documentation (Start Here)

Essential documentation for all users:

Document	Purpose	When to Read
README.md	Complete feature guide, installation, and configuration	First read for new users
QUICKSTART.md	5-minute setup guide	When you want to get started fast
CONTRIBUTING.md	Development setup and contribution guidelines	Before contributing code
CODE_OF_CONDUCT.md	Community standards	Before participating in the project
SECURITY.md	Security policy and vulnerability reporting	When reporting security issues
SUPPORT.md	Getting help and support channels	When you need assistance
CHANGELOG.md	Version history and release notes	Upgrading or checking what's new
CLAUDE.md	AI assistant development instructions	Using Claude Code or GitHub Copilot

/docs Directory - Comprehensive Documentation

Detailed documentation organized by topic:

📖 Reference Documentation

In-depth feature documentation:

• CONFIGURATION.md - Complete configuration options reference
• MONITORING_SYSTEM.md - Automated monitoring architecture and setup
• NOTIFICATIONS.md - Real-time alerts (Slack, Telegram, Email, Discord)
• TESTING.md - Testing strategy, guidelines, and running tests

🔧 Setup Guides

Advanced deployment and configuration guides:

• ORPHANED_BRANCH_SETUP.md - Upptime-style status-data branch configuration
• TRUSTED_PUBLISHING_SETUP.md - npm OIDC trusted publishing setup
• PUBLISHING.md - Release workflow and version publishing

🏗️ Architecture Documentation

Understanding internal design and structure:

• ARCHITECTURE-INDEX.md - Overview of architectural documentation
• ARCHITECTURE-SUMMARY.md - High-level system design
• ARCHITECTURE-ANALYSIS.md - Detailed technical analysis

📦 Archive

Historical and legacy documentation:

• CODE-REFERENCE-GUIDE.md - Legacy code navigation guide
• PROJECT_SUMMARY.md - Original project summary
• NOTIFICATION-SYSTEM-SUMMARY.md - Notification implementation notes
• UPPTIME_CONFIGURATION_COMPARISON.md - Upptime comparison

🎯 Find What You Need

By Task

I want to...

• Install the plugin → README.md - Installation
• Get started quickly → QUICKSTART.md
• Configure options → docs/reference/CONFIGURATION.md
• Set up automated monitoring → docs/reference/MONITORING_SYSTEM.md
• Add notification alerts → docs/reference/NOTIFICATIONS.md
• Deploy to GitHub Pages → README.md - GitHub Actions Setup
• Use orphaned branch → docs/setup/ORPHANED_BRANCH_SETUP.md
• Track maintenance windows → README.md - Maintenance Tickets
• Understand architecture → docs/architecture/ARCHITECTURE-INDEX.md
• Contribute code → CONTRIBUTING.md
• Run tests → docs/reference/TESTING.md
• Publish a release → docs/setup/PUBLISHING.md

By Role

Developers

1. QUICKSTART.md - Quick setup
2. CONTRIBUTING.md - Development workflow
3. docs/reference/TESTING.md - Testing guidelines
4. CLAUDE.md - AI-assisted development

DevOps/Platform Engineers

1. docs/reference/MONITORING_SYSTEM.md - Monitoring setup
2. docs/setup/ORPHANED_BRANCH_SETUP.md - Branch strategy
3. docs/reference/NOTIFICATIONS.md - Alert configuration
4. README.md - GitHub Actions - CI/CD workflows

Site Administrators

1. README.md - Complete feature overview
2. docs/reference/CONFIGURATION.md - Configuration options
3. README.md - Maintenance Tickets - Scheduling maintenance

Architects

1. docs/architecture/ARCHITECTURE-INDEX.md - System design
2. docs/architecture/ARCHITECTURE-SUMMARY.md - High-level overview
3. docs/archive/UPPTIME_CONFIGURATION_COMPARISON.md - Upptime comparison

🔍 Search Tips

All documentation is in Markdown format and searchable via:

• GitHub's built-in search - Use the search bar at the top of the repo
• Command+F / Ctrl+F - Search within individual documents
• grep - grep -r "search term" docs/

📝 Documentation Standards

All documentation follows these standards:

• ✅ GitHub-flavored Markdown
• ✅ Clear hierarchical structure with descriptive headers
• ✅ Working code examples for all features
• ✅ Cross-references to related documentation
• ✅ Version notes for new features (e.g., "v0.5.0+")
• ✅ Reflects current implementation (v0.14.0)

🆘 Need Help?

If you can't find what you're looking for:

1. Search Issues - GitHub Issues
2. Ask in Discussions - GitHub Discussions
3. Read Support Guide - SUPPORT.md

🤝 Contributing to Documentation

Found an error or want to improve the docs?

1. Read CONTRIBUTING.md for guidelines
2. Documentation PRs are welcome and appreciated!
3. All docs should be kept current with the codebase

📦 Version Information

Current Version: v0.14.0 Documentation Last Updated: November 2025 Docusaurus Compatibility: v3.0+ Node.js Requirement: v20.0+

🔗 External Resources

• npm Package: @amiable-dev/docusaurus-plugin-stentorosaur
• GitHub Repository: amiable-dev/docusaurus-plugin-stentorosaur
• Upptime (Inspiration): upptime/upptime
• Docusaurus: docusaurus.io

---

💡 Tip: Bookmark this page for quick access to all documentation!