Smartsheet Integration Suite Documentation

Comprehensive documentation for all Smartsheet integration repositories

📚 Live Documentation: https://jflo21.github.io/smartsheet-integration-docs/

Overview

This repository hosts the centralized documentation for the Smartsheet Integration Suite - a collection of 6 Python and TypeScript applications that automate data synchronization, reporting, and validation workflows.

Covered Repositories

1. Supabase Smartsheet Promax Offload - Database to Smartsheet sync
2. Smartsheet Supabase Sync - Smartsheet to database sync
3. Master to Sibling Smartsheet - Sheet-to-sheet replication
4. Generate Job Numbers - Automated job numbering
5. Generate Weekly PDFs - Weekly PDF reports
6. Resiliency PDF Restructure - PDF validation

Features

• 📖 Comprehensive Guides - Setup, usage, and maintenance documentation
• 🏗️ Architecture Diagrams - Visual representation of data flows
• ⚠️ Critical Warnings - Watch out for common pitfalls
• 🔧 Troubleshooting - Solutions to common issues
• 🎨 Beautiful Theme - Material for MkDocs with dark/light mode
• 🔍 Full-Text Search - Find what you need quickly
• 📱 Mobile Responsive - Works on all devices

Documentation Sections

• Home - Overview and quick start
• Master Index - Complete repository catalog
• Usage Guide - Setup and configuration
• Smartsheet Integration - Data flows and mappings
• Watch Out For - Critical pitfalls
• Maintenance Guide - Update procedures
• Troubleshooting - Common issues
• Repositories - Detailed repository docs

Local Development

Prerequisites

• Python 3.9 or higher
• pip package manager

Setup

1. Clone the repository

   git clone https://github.com/JFlo21/smartsheet-integration-docs.git
   cd smartsheet-integration-docs

2. Install dependencies

   pip install -r requirements.txt

3. Serve locally

   mkdocs serve

4. Open in browser

   http://127.0.0.1:8000
   

Building

To build the static site:

mkdocs build

The site will be generated in the site/ directory.

Contributing

We welcome contributions! Here's how you can help:

Editing Documentation

1. Fork this repository
2. Create a branch for your changes
3. Edit markdown files in the docs/ directory
4. Test locally with mkdocs serve
5. Submit a pull request

Quick Edits

Every page has an "Edit this page" button (✏️) in the top right that links directly to the source file on GitHub.

Adding New Pages

1. Create a new .md file in the appropriate docs/ subdirectory
2. Add the page to nav section in mkdocs.yml
3. Test the navigation works correctly

Reporting Issues

Found an error or have a suggestion? Open an issue!

Project Structure

smartsheet-integration-docs/
├── .github/
│   └── workflows/
│       ├── deploy-pages.yml      # Deploys docs on push to main
│       └── sync-docs.yml         # Weekly sync from source repos
├── docs/
│   ├── index.md                  # Home page
│   ├── master-index.md           # Repository catalog
│   ├── usage-guide.md            # Setup guide
│   ├── smartsheet-integration.md # Integration details
│   ├── watch-out-for.md          # Critical warnings
│   ├── maintenance-guide.md      # Maintenance procedures
│   ├── troubleshooting.md        # Troubleshooting guide
│   ├── stylesheets/
│   │   └── extra.css             # Custom styles
│   └── repositories/
│       ├── index.md              # Repositories overview
│       └── *.md                  # Individual repo docs
├── mkdocs.yml                    # MkDocs configuration
├── requirements.txt              # Python dependencies
└── README.md                     # This file

Technology Stack

• MkDocs - Static site generator
• Material for MkDocs - Beautiful theme
• GitHub Actions - CI/CD automation
• GitHub Pages - Free hosting

Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.

Manual Deployment

To deploy manually:

mkdocs gh-deploy

This builds the site and pushes it to the gh-pages branch.

License

MIT License - see LICENSE file for details.

Support

• Documentation Issues: Open an issue
• Integration Issues: Check the Troubleshooting Guide
• Questions: Refer to individual repository documentation

---

Built with ❤️ for efficient business operations

📚 View Live Documentation