Skip to content

Misca-Team/menu-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Misca

Digital menu platform is at your disposal quickly!

.NET Status Docs License

Misca is a platform for creating and managing digital menus for cafés, restaurants, and similar businesses.

This repository contains the official public documentation for Misca, focused on business concepts, user flows, and public API usage.

📄 Documentation Structure

All documentation lives inside the docs directory and is organized for easy navigation and human-readable understanding.

Start here:

How to read this documentation

This documentation is flow-oriented, not endpoint-first.

Recommended reading order:

  1. Concepts
  2. Authentication
  3. Flows (real-world scenarios)
  4. API Overview
  5. Swagger (for exact request/response details)

API Reference

Detailed API specifications are available via Swagger and should be used as the primary technical reference for endpoints, schemas, and parameters.

Links to Swagger are provided in the API section.

Scope

  • ✅ Business concepts and terminology
  • ✅ User and system flows
  • ✅ High-level API usage guidance
  • ❌ Internal implementation details
  • ❌ Source code

Audience

This documentation is intended for:

  • Frontend developers
  • Backend integrators
  • Third-party service providers
  • Technical reviewers

For contributions or suggestions regarding documentation, please open an issue or submit a pull request.

About

Official documentation for Misca platform, including business concepts, user flows, and public API usage guides.

Topics

Resources

License

Stars

Watchers

Forks