Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

QuorimService/documentation

Repository files navigation

Quorim Documentation

Welcome to the official documentation repository for Quorim.

This repository serves as the central hub for all Quorim-related documentation, including feature explanations, guides, workflows, and internal references. It is intended to help contributors, staff, and approved community members understand and improve the Quorim platform.


📘 Purpose

The goal of this repository is to:

  • Maintain clear and up-to-date documentation for Quorim
  • Centralize guides, references, and explanations
  • Allow collaborative improvements through controlled community contributions

🚀 Getting Started

Quorim documentation is built and managed using Mintlify.

To get started:

  1. Fork this repository to your own GitHub account
  2. Make your documentation changes in your fork
  3. Submit a Pull Request (PR) to this repository

⚠️ Direct pushes to this repository are strictly not allowed.
All changes must go through a Pull Request and review process.


📝 Documentation Guidelines

To ensure high-quality and consistent documentation, please follow these rules:

  • Documentation must be clear, structured, and easy to understand
  • Use images, diagrams, or screenshots wherever they improve clarity
  • Follow Mintlify’s formatting and structure standards
  • Keep content accurate, concise, and professional

✨ Feature Documentation Rules

If you are documenting a feature:

  • The feature must be fully completed and finalized before submitting a Pull Request
  • Incomplete, unfinished, or speculative documentation will not be accepted
  • All documented behavior must reflect the actual implementation
  • Include relevant examples and visuals where applicable

🔁 Pull Request Requirements

Before submitting a Pull Request, ensure that:

  • Your changes are complete and well-structured
  • Any images used are properly added and referenced
  • The documentation builds correctly with Mintlify
  • The content follows all rules outlined above

Pull Requests that do not meet these requirements may be rejected.


🤝 Contributions

Contributions are welcome and encouraged.

By contributing to this repository, you agree that:

  • Your contributions become part of the Quorim documentation
  • Your contributions are licensed under the same terms as this repository
  • You do not retain independent rights to reuse or redistribute contributed content elsewhere

Please ensure all contributions are relevant, accurate, and aligned with Quorim’s standards.


🔒 Usage Restrictions

This documentation is publicly viewable and open for contribution, but it is not open-source.

You may:

  • View and read the documentation
  • Submit contributions to improve the content

You may NOT:

  • Use this documentation for commercial purposes
  • Copy, redistribute, or republish this content
  • Modify or adapt this content for use in other projects, services, or platforms

📜 License

This repository is licensed under the
Creative Commons Attribution–NonCommercial–NoDerivatives 4.0 International (CC BY-NC-ND 4.0) license.

See the LICENSE file for full details.


© Quorim. All rights reserved.

About

Quorim documentation hub for product features, internal workflows, and technical guidance.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages