Skip to content

solveforceapp/SolveForce.com

Repository files navigation

SOLVEFORCE.COM Documentation

Complete mdbook documentation for SOLVEFORCE.COM telecommunications and IT services.

Quick Start

Prerequisites

  • Rust and Cargo (for mdbook)
  • Or use pre-built binaries

Install mdbook

# Using Cargo
cargo install mdbook

# Or download binary from
# https://github.com/rust-lang/mdBook/releases

Build the Documentation

# Build the book
mdbook build

# Serve locally with live reload
mdbook serve

# Open browser to http://localhost:3000

Structure

SOLVEFORCE.COM/
├── book.toml              # mdbook configuration
├── src/
│   ├── SUMMARY.md         # Table of contents
│   ├── introduction.md    # Introduction page
│   ├── getting-started/   # Getting started guides
│   ├── services/          # Service documentation
│   ├── guide/             # User guides
│   ├── api/               # API reference
│   ├── integration/       # Integration guides
│   ├── troubleshooting/   # Troubleshooting
│   ├── resources/         # Additional resources
│   ├── development/       # Development guides
│   └── appendix/          # Appendix
└── book/                  # Generated output (gitignored)

Deployment

To GitHub Pages

The GitHub Actions workflow will automatically build and deploy to GitHub Pages when changes are pushed to main.

Manual Deployment

# Build the book
mdbook build

# The output is in the book/ directory
# Deploy book/ directory to your web server

Contributing

  1. Edit markdown files in src/
  2. Update SUMMARY.md if adding new pages
  3. Test locally with mdbook serve
  4. Commit and push changes
  5. GitHub Actions will deploy automatically

License

Copyright © 2025 SolveForce. All rights reserved.

Support