Skip to content

SimpleHomelab/Deployrr-Docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

Deployrr Documentation

Deployrr Logo

Overview

This repository contains the official documentation for Deployrr, a sophisticated application deployment tool designed to simplify container management and application deployment processes. The documentation is built using WikiDocs and available at https://docs.deployrr.app.

Purpose

The Deployrr documentation aims to provide:

  • Comprehensive guides for setting up and using Deployrr
  • Best practices for container deployment and management
  • Technical references for configuration and customization
  • Troubleshooting guides and common solutions

Documentation Structure

The documentation follows a hierarchical structure inside the documents folder:

documents/
├── category1/
│   ├── document1/
│   │   ├── content.md
│   │   └── versions/
│   └── document2/
│       ├── content.md
│       └── versions/
└── category2/
    └── document3/
        ├── content.md
        └── versions/

Each document:

  • Lives in its own folder under the appropriate category
  • Contains the main content in content.md
  • May include a versions folder containing previous revisions saved by WikiDocs

Contributing

Contributions to improve the documentation are welcome. To contribute:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes following the documentation guidelines
  4. Submit a pull request

To add new documentation:

  1. Choose or create an appropriate category folder
  2. Create a new document folder within that category
  3. Add the content following the standard format

Local Development

To work on the documentation locally:

  1. Clone the repository
  2. Install required dependencies
  3. Make your changes
  4. Preview changes using a Markdown viewer
  5. Submit your contribution

Links

For support and discussions:

License

This documentation is maintained by Anand. All rights reserved.

About

Documentation for Deployarr Users

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published