From 1597b1b89db568699b961a703fecc465ebcb1176 Mon Sep 17 00:00:00 2001 From: marcelo-m7 Date: Sat, 8 Nov 2025 15:58:20 +0000 Subject: [PATCH] feat: Update project documentation and sidebar links to reflect legacy status and Portuguese paths --- docs/projects/_category_.json | 6 +- docs/projects/boteco-pro.md | 260 +--------------------------------- docusaurus.config.js | 2 +- sidebars.js | 13 +- 4 files changed, 18 insertions(+), 263 deletions(-) diff --git a/docs/projects/_category_.json b/docs/projects/_category_.json index 968afa9..c2b01dc 100644 --- a/docs/projects/_category_.json +++ b/docs/projects/_category_.json @@ -1,8 +1,8 @@ { - "label": "Projects", - "position": 2, + "label": "Projects (legacy)", + "position": 99, "link": { "type": "generated-index", - "description": "Documentation for all Monynha Softwares projects, including overviews, tech stacks, features, and contribution guidelines." + "description": "LEGACY: Duplicate/legacy English project pages. Prefer /docs/projetos/* (Portuguese)." } } \ No newline at end of file diff --git a/docs/projects/boteco-pro.md b/docs/projects/boteco-pro.md index 26c1db9..5ad827f 100644 --- a/docs/projects/boteco-pro.md +++ b/docs/projects/boteco-pro.md @@ -3,53 +3,13 @@ title: "Boteco Pro — Project Overview" sidebar_position: 1 --- -Boteco Pro is a management system for bars and restaurants. It centralizes orders, inventory, staff, and financial operations while providing real-time insights and integrations with common hospitality services. +This page is retained for compatibility. The canonical project documentation now lives under the Portuguese `projetos` section. -## Target audience +Please visit the canonical page for Boteco Pro: -- Bar and restaurant owners -- Small to medium-sized hospitality businesses -- Hospitality professionals looking to digitize operations +[Boteco Pro — Página principal](/docs/projetos/boteco-pro) -## Problem solved - -Boteco Pro addresses common hospitality pain points: - -- Manual order tracking and inventory mistakes -- Inefficient or delayed financial reporting -- Lack of real-time business metrics and insights -- Fragmented integrations with POS and payment systems - -## Tech stack & architecture - -### Core technologies - -- **Frontend**: Flutter (cross-platform mobile) -- **Backend**: Convex (real-time services and sync) -- **Database**: Convex built-in/document-store features -- **State management**: Provider pattern (Flutter) - -### Architecture overview - -- Mobile app (Flutter) communicates with Convex for real-time updates. -- Offline-first design with local persistence and background sync. -- RESTful APIs for third-party integrations (payment gateways, POS, analytics). - -## Integration points - -- Payment gateways (consider PCI/security requirements). -- POS systems (inventory / orders synchronization). -- Analytics and reporting tools. - -## Features & roadmap - -### Current (v1.0) - -- Real-time order management -- Inventory control with low-stock alerts -- Financial summaries (daily/weekly/monthly) -- Customer profiles and order history -- Basic staff/role management +If you maintain docs links that point to `/docs/projects/*`, consider updating them to `/docs/projetos/*`. ### Planned @@ -87,215 +47,3 @@ cd boteco-pro flutter pub get ``` -1. Configure Convex (example) - -```bash -npx convex dev --once -``` - -1. Run the app - -```bash -flutter run -``` - -### Environment - -Create a `.env` (or use your preferred env method): - -```bash -CONVEX_URL=your_convex_deployment_url -API_KEY=your_api_key -``` - -## Contributing - -Follow the general Monynha contribution guidelines and testing requirements. For repository-level notes, see the [general contribution guidelines](../contribution/contributing.md). - -# Boteco Pro – Project Overview------ - - - -Boteco Pro is a comprehensive management system designed for bars and restaurants, providing complete control over orders, inventory, and financial operations.sidebar_position: 1sidebar_position: 1 - - - -## Target Audience------ - - - -- Bar and restaurant owners - -- Small to medium-sized hospitality businesses - -- Hospitality industry professionals seeking digital transformation# Boteco Pro – Project Overview# Boteco Pro – Project Overview - - - -## Problem Solved - - - -Boteco Pro addresses the common challenges faced by hospitality businesses:Boteco Pro is a comprehensive management system designed for bars and restaurants, providing complete control over orders, inventory, and financial operations.Boteco Pro is a comprehensive management system designed for bars and restaurants, providing complete control over orders, inventory, and financial operations. - - - -- Manual order tracking and inventory management - -- Inefficient financial reporting - -- Lack of real-time business insights## Target Audience## Target Audience - -- Difficulty in managing customer relationships - - - -## Tech Stack & Architecture - -- Bar and restaurant owners- Bar and restaurant owners - -### Core Technologies - -- Small to medium-sized hospitality businesses- Small to medium-sized hospitality businesses - -- **Frontend**: Flutter for cross-platform mobile application - -- **Backend**: Convex for real-time backend services- Hospitality industry professionals seeking digital transformation- Hospitality industry professionals seeking digital transformation - -- **Database**: Integrated database solutions within Convex - -- **State Management**: Provider pattern with Flutter - - - -### Architecture Components## Problem Solved## Problem Solved - - - -- **Mobile App**: Cross-platform Flutter application for iOS and Android - -- **Real-time Backend**: Convex handles real-time data synchronization - -- **Offline Support**: Local data persistence for offline operationsBoteco Pro addresses the common challenges faced by hospitality businesses:Boteco Pro addresses the common challenges faced by hospitality businesses: - -- **API Integration**: RESTful APIs for third-party integrations - -- Manual order tracking and inventory management - -### Integration Points - -- Manual order tracking and inventory management- Inefficient financial reporting - ---- -title: "Boteco Pro — Project Overview" -sidebar_position: 1 ---- - -Boteco Pro is a management system for bars and restaurants. It aims to centralize orders, inventory, staff and financial operations while providing real-time insights and integrations with common hospitality services. - -## Target audience - -- Bar and restaurant owners -- Small to medium-sized hospitality businesses -- Hospitality professionals looking to digitize operations - -## Problem solved - -Boteco Pro addresses common hospitality pain points: - -- Manual order tracking and inventory mistakes -- Inefficient or delayed financial reporting -- Lack of real-time business metrics and insights -- Fragmented integrations with POS and payment systems - -## Tech stack & architecture - -### Core technologies - -- **Frontend**: Flutter (cross-platform mobile) -- **Backend**: Convex (real-time services and sync) -- **Database**: Convex built-in/document-store features -- **State management**: Provider pattern (Flutter) - -### Architecture overview - -- Mobile app (Flutter) communicates with Convex for real-time updates -- Offline-first design with local persistence and background sync -- RESTful APIs for third-party integrations (payment gateways, POS, analytics) - -## Integration points - -- Payment gateways (PCI considerations) -- POS systems (inventory / orders sync) -- Analytics and reporting tools - -## Features & roadmap - -### Current (v1.0) - -- Real-time order management -- Inventory control with low-stock alerts -- Financial summaries (daily/weekly/monthly) -- Customer profiles and order history -- Basic staff/role management - -### Planned - -- Advanced analytics dashboards -- Loyalty / rewards system -- Multi-location management -- Web-based ordering integration - -## Development status - -- Current phase: Beta testing with select partners -- Next milestone: v1.1 (enhanced reporting) -- Target for full v1.0: Q1 2026 - -## Setup & local development - -### Prerequisites - -- Flutter SDK (3.x+) -- Dart SDK (2.19+) -- Convex account / project setup - -### Quick start - -1. Clone the repository - -```bash -git clone https://github.com/Monynha-Softwares/Boteco-Pro.git -cd boteco-pro -``` - -2. Install dependencies - -```bash -flutter pub get -``` - -3. Configure Convex (example) - -```bash -npx convex dev --once -``` - -4. Run the app - -```bash -flutter run -``` - -### Environment - -Create a `.env` (or otherwise set env vars): - -``` -CONVEX_URL=your_convex_deployment_url -API_KEY=your_api_key -``` - -## Contributing - -Follow the general Monynha contribution guidelines and testing requirements. For repository-level notes, see the [general contribution guidelines](../contribution/contributing.md). diff --git a/docusaurus.config.js b/docusaurus.config.js index 922a1b6..cfbb118 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -98,7 +98,7 @@ const config = { position: 'left', items: [ { to: '/docs/intro', label: 'Introdução' }, - { to: '/docs/projects/boteco-pro', label: 'Projetos' }, + { to: '/docs/projetos/boteco-pro', label: 'Projetos' }, { to: '/docs/technologies/frontend-stack', label: 'Tecnologias' }, { to: '/docs/guidelines/ux-guidelines', label: 'Guidelines' }, { to: '/docs/identity/brand-guidelines', label: 'Identidade' }, diff --git a/sidebars.js b/sidebars.js index f817f98..74552ae 100644 --- a/sidebars.js +++ b/sidebars.js @@ -20,13 +20,20 @@ const sidebars = { 'intro', { type: 'category', - label: 'Projects', + label: 'Projetos', link: { type: 'generated-index', - description: 'Documentation for all Monynha Softwares projects, including overviews, tech stacks, features, and contribution guidelines.', + description: 'Documentação dos projetos Monynha (visões gerais, stacks e guias).', }, items: [ - 'projects/boteco-pro' + 'projetos/boteco-pro/index', + 'projetos/artleo-creative-spaces/index', + 'projetos/boteco-pt/index', + 'projetos/facodi/index', + 'projetos/monynha-com/index', + 'projetos/monynha-online/index', + 'projetos/monynha-tech/index', + 'projetos/sweet-price/index' ] }, {