Skip to content

Latest commit

 

History

History

docs

README.md

Documentation Index

Welcome to the Enterprise Support App documentation! This directory contains comprehensive guides to help you get started, develop, configure, and contribute to this project.

📚 Available Documentation

Getting Started

  • Quick Start Guide - Get up and running in minutes
    • Initial setup for all developers
    • Web development workflow
    • iOS development workflow (Mac only)
    • Common commands and tips

Configuration

  • Configuration Guide - Customize the app for your organization
    • Company branding and settings
    • Contact information setup
    • Regional configuration
    • Advanced deployment options

Platform-Specific Guides

  • iOS Development Guide - iOS-specific development
    • Prerequisites for Mac and Windows
    • Development workflow
    • Building for production
    • App Store submission
    • Troubleshooting

App Store & Deployment

  • iOS Deployment Setup - Complete deployment setup guide

    • Required GitHub secrets configuration
    • Certificate setup walkthrough
    • Validation components
    • Troubleshooting deployment issues

  • Apple Connect Metadata - App Store metadata automation

    • Automated metadata uploads
    • Screenshots and app previews
    • Categories and descriptions
    • URL configuration

  • Apple Connect Copyright Automation - Copyright field automation

    • Automatic year updates
    • Configuration and customization
    • Validation and testing

  • CI/CD Pipeline - Continuous integration and deployment

    • GitHub Actions workflows
    • Automated releases
    • Deployment process

  • Fastlane Precheck Warnings - Resolving deployment warnings

    • Copyright date issues
    • URL validation errors
    • Best practices for metadata maintenance

Content Management

  • Document Management - Managing support documents
    • Document structure
    • Adding new documents
    • Using placeholders
    • Testing and best practices

Design & Planning

🚀 Quick Links

For New Developers

  1. Start with the Quick Start Guide
  2. Review the Configuration Guide to customize the app
  3. Read the Contributing Guide if you plan to contribute

For iOS Developers

  1. Check the iOS Development Guide for platform-specific setup
  2. Review the iOS Deployment Setup Guide for App Store deployment configuration
  3. Review iOS-specific commands and workflows
  4. Understand the build and deployment process

For Content Creators

  1. Read the Document Management Guide
  2. Learn about the Markdown file structure
  3. Understand placeholder usage for company-specific content

📖 Additional Resources

Project Files

External Resources

🤔 Need Help?

📝 Documentation Improvements

Found a problem with the documentation? We welcome improvements!

🗂️ Documentation Structure

docs/
├── README.md                           # This file - documentation index
├── QUICK_START.md                      # Getting started guide
├── CONFIGURATION.md                    # Configuration options
├── THEME_CONFIGURATION.md              # Theme and styling configuration
├── iOS_DEVELOPMENT.md                  # iOS development guide
├── DEPLOY_SETUP.md                     # iOS deployment setup guide
├── APPLE_CONNECT_METADATA.md           # App Store metadata automation
├── APPLE_CONNECT_COPYRIGHT_AUTOMATION.md # Copyright automation
├── CI_CD.md                            # CI/CD pipeline documentation
├── FASTLANE_PRECHECK_WARNINGS.md       # Deployment warnings troubleshooting
├── DEPLOYMENT_SIMPLIFICATION.md        # Deployment process overview
├── DOCUMENTS.md                        # Document management guide
├── APP_ICON_SETUP.md                   # App icon configuration
├── PRIVACY.md                          # Privacy policy
├── TROUBLESHOOTING.md                  # General troubleshooting
└── PRD.md                              # Product requirements document