PERSCOM Documentation

The official documentation for PERSCOM, built with Mintlify.

About PERSCOM

PERSCOM is a powerful personnel management platform built for military simulation units, emergency services, and public safety organizations. It provides tools for managing personnel records, assignments, awards, qualifications, and more.

Documentation Structure

Directory	Description
docs/	General product documentation
guides/	Step-by-step user guides
integrations/	API, SDKs, webhooks, and third-party integrations
api-reference/	Complete API endpoint documentation

Local Development

Prerequisites

• Node.js (v18 or higher)
• npm or yarn

Setup

1. Clone the repository:

   git clone https://github.com/DeschutesDesignGroupLLC/perscom-docs.git
   cd perscom-docs

2. Install the Mintlify CLI:

   npm i -g mintlify

3. Install dependencies:

   npm install

4. Start the development server:

   mintlify dev

5. Open http://localhost:3000 in your browser.

Formatting

Run Prettier to format files before committing:

npm run format

Contributing

We welcome contributions to improve the documentation. Please see CONTRIBUTING.md for guidelines.

Quick Contribution Guide

1. Fork the repository
2. Create a feature branch (git checkout -b improve-docs)
3. Make your changes
4. Run npm run format to format your changes
5. Commit your changes (git commit -m "Improve X documentation")
6. Push to the branch (git push origin improve-docs)
7. Open a Pull Request

Resources

• PERSCOM Website
• Live Documentation
• API Reference
• Community Slack

License

This documentation is open source and available under the MIT License.