Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/content-audit-2025-11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Content Audit — November 2025
sidebar_position: 99
---

# Content Audit — November 2025

This report summarises the documentation clean-up performed in November 2025. Use it as a changelog and as a reference for future audits.

## Pages removed or archived

- **Repositories (legacy)** — Retained but explicitly marked as archived and documented when it is safe to delete. No other pages were removed.

## Pages updated

| Page | Summary of improvements |
| --- | --- |
| [Intro](./intro.md) | Expanded welcome message, clarified how to navigate MonaDocs, and added a quick-start checklist for new contributors. |
| [Repositories](./repositories/index.mdx) | Documented URL parameters, caching behaviour, authentication options, and accessibility considerations for the interactive listing. |
| [Repositories (legacy)](./repositories/index.md) | Reframed as an archived fallback with clear guidance on decommissioning. |
| [Boteco Pro](./projects/boteco-pro.md) | Replaced placeholder content with product overview, modules, technology landscape, roadmap, and contribution workflow. |
| [Boteco.pt](./projects/boteco-pt/index.md) | Added business objectives, audience, UX guidelines, technical implementation notes, and roadmap. |
| [ArtLeo Creative Spaces](./projects/artleo-creative-spaces/index.md) | Detailed product pillars, reference stack, delivery workflow, and roadmap for the discovery phase. |
| [FACODI](./projects/facodi/index.md) | Clarified value proposition, architecture, compliance stance, and contribution expectations. |
| [Monynha.com](./projects/monynha-com/index.md) | Documented site structure, content standards, operations, and roadmap. |
| [Monynha Online](./projects/monynha-online/index.md) | Captured use cases, configuration options, technical overview, and contribution notes. |
| [MonynhaTech](./projects/monynha-tech/index.md) | Added goals, module breakdown, architecture, editorial workflow, and roadmap. |
| [Sweet Price](./projects/sweet-price/index.md) | Expanded problem statement, capabilities, stack, data governance, and contribution practices. |

## New pages created

| Page | Location | Summary |
| --- | --- | --- |
| [Projects Overview](./projects/overview.md) | `docs/projects/overview.md` | Portfolio-level snapshot with status, tech stack, and guidance for proposing new projects. |

## Next steps

- Review technology pages during the next sprint to ensure they match current stack decisions.
- Align project roadmaps with the quarterly OKR review and update dates accordingly.
- Instrument analytics dashboards to monitor engagement with newly expanded project pages.
27 changes: 18 additions & 9 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,24 @@ sidebar_position: 1

# Welcome to MonaDocs

This is the central documentation hub for **Monynha Softwares**, containing guides, standards, and information about our projects, technologies, and processes.
**MonaDocs** is the central documentation hub for **Monynha Softwares**. It brings together our product vision, architectural decisions, operating standards, and contributor guidance so that every team member and partner can work with the same context.

## What you'll find here
## How to use this site

- **Projects**: Detailed documentation for each project developed by Mona.
- **Technologies**: Guides about the technologies we use.
- **Internal Standards**: Code norms, architecture, and best practices.
- **Guides and Best Practices**: Tutorials and recommendations for development.
- **Contributor Documentation**: How to contribute to our projects.
- **Other Topics**: Topics like UX, accessibility, and data.
- **Projects** – Explore current initiatives, their business goals, feature roadmaps, and implementation details.
- **Technologies** – Review the approved stacks, reference architectures, and hands-on guides for the platforms we rely on.
- **Architecture** – Understand how the monorepo is organised, how services communicate, and how we deploy software.
- **Internal Standards** – Follow our coding conventions, security requirements, UX and accessibility rules, and operational checklists.
- **Contribution** – Learn how we collaborate, from governance to contribution workflows and review processes.
- **Playbooks & Guides** – Find repeatable procedures for delivery, incident response, and other cross-team practices.

Explore the sections in the sidebar for more information.
Use the sidebar or the search bar to jump directly to the topic you need. Each page lists related content so you can keep exploring.

## Quick start for new contributors

1. Read the [Contribution Guide](contribution/contributing.md) for branching, review, and release conventions.
2. Familiarise yourself with the [Architecture](architecture/monorepo-structure.md) section to understand our monorepo layout and CI/CD strategy.
3. Review the [Code Conventions](guidelines/code-conventions.md) and [Accessibility Guidelines](guidelines/accessibility.md) before opening your first pull request.
4. Visit the [Projects](projects/overview.md) catalog to see active workstreams and select where you can help.

If you spot missing information, please open an issue or submit an update—documentation is a shared responsibility.
48 changes: 39 additions & 9 deletions docs/projects/artleo-creative-spaces/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,49 @@
# ArtLeo Creative Spaces

## Description
## Overview

Art by Monynha
ArtLeo Creative Spaces is a digital platform under active discovery. It aims to connect independent artists with venues that host exhibitions, workshops, and creative residencies. The documentation below captures the current understanding of scope and technical direction so contributors can collaborate consistently.

## Technologies
## Target users

- TypeScript
- Visual artists and makers who need a professional showcase and booking calendar.
- Venue managers responsible for programming art events.
- Curators looking for curated collections and available time slots.

## Repository
## Product pillars

[GitHub: artleo-creative-spaces](https://github.com/Monynha-Softwares/artleo-creative-spaces)
1. **Portfolio publishing** – Responsive galleries, media kits, and artist bios optimised for search engines.
2. **Space discovery** – Location-aware search with filters for availability, amenities, and equipment.
3. **Booking workflow** – End-to-end request, approval, and contract management with notifications.
4. **Community insights** – Dashboards showing attendance, sales, and engagement metrics.

## Features
## Reference technology stack

- Creative and artistic spaces platform
- Platform for artistic expression
The stack will continue to evolve; align with the tech lead before introducing alternatives.

- **Frontend**: Next.js + TypeScript with Tailwind CSS for rapid UI development.
- **Backend**: Supabase (PostgreSQL + Auth) providing database, storage, and row-level security.
- **Integrations**: Stripe for payments, Mapbox for geolocation, Resend for transactional email.
- **Infrastructure**: Vercel preview/production environments orchestrated by GitHub Actions workflows.

## Delivery workflow

- **Branching**: `main` (production), `develop` (staging), feature branches per issue.
- **CI/CD**: Automated linting, testing, and preview deployments on pull requests.
- **Monitoring**: Vercel Analytics, Supabase logs, and Sentry for runtime errors.
- **Environments**: Shared staging database seeded weekly; production backups nightly.

## Roadmap highlights

| Milestone | Focus | ETA |
| --- | --- | --- |
| Artist onboarding UX | Simplify signup, add progressive profile completion | 2025-Q1 |
| Venue CRM tooling | Improve lead tracking, add automated follow-ups | 2025-Q2 |
| Marketplace launch | Public discovery experience with SEO landing pages | 2025-Q3 |

## How to contribute

1. Check the open issues labelled `help wanted` in the repository.
2. Discuss major UX or architectural changes with the product owner before implementation.
3. Follow the shared [code conventions](../../guidelines/code-conventions.md) and include accessibility acceptance criteria in every PR.
4. Provide screenshots or Loom videos for UI updates and ensure English/Portuguese copy parity.
65 changes: 34 additions & 31 deletions docs/projects/boteco-pro.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,52 @@
---
title: "Boteco Pro — Project Overview"
title: "Boteco Pro"
sidebar_position: 1
---

This compatibility page points to the canonical project documentation under the `projects` section.
# Boteco Pro

Please visit the canonical page for Boteco Pro:
## Overview

[Boteco Pro — Project Page](/docs/projects/boteco-pro)
Boteco Pro is Monynha Softwares' flagship hospitality management platform. It consolidates point-of-sale, inventory, reservations, and loyalty experiences into a single suite tailored for bars and restaurants in Portugal and beyond.

If you maintain docs links that point to `/docs/projetos/*`, consider updating them to `/docs/projects/*`.
## Customer outcomes

### Planned
- Reduce manual reconciliation by synchronising sales, stock, and accounting data.
- Increase table turnover with smart reservations, waitlist management, and QR ordering.
- Grow repeat business through integrated loyalty programs and segmented campaigns.

- Advanced analytics dashboards
- Loyalty / rewards system
- Multi-location management
- Web-based ordering integration
## Product modules

## Development status
1. **Point of Sale** – Multi-terminal POS with offline mode, receipt customisation, and tipping.
2. **Inventory & Procurement** – Supplier catalogues, purchase orders, and automated stock alerts.
3. **Reservations & Floor Management** – Table layouts, pacing controls, and guest communications.
4. **Loyalty & Marketing** – Tiered rewards, email/SMS campaigns, and customer analytics dashboards.
5. **Insights** – Real-time KPI cockpit covering revenue, labour costs, and menu performance.

- Current phase: Beta testing with select partners
- Next milestone: v1.1 (enhanced reporting)
- Target for full v1.0: Q1 2026
## Technology landscape

## Setup & local development
- **Mobile**: Flutter app for in-venue operations and tablet ordering.
- **Backend**: Convex for realtime data synchronisation, complemented by serverless functions for heavy processing.
- **Integrations**: Fiscal printers, payment gateways, delivery platforms, and accounting tools (TIC, Sage, Xero).
- **Infrastructure**: Containerised services orchestrated via Coolify with GitHub Actions CI/CD.

### Prerequisites
## Deployment model

- Flutter SDK (3.x+)
- Dart SDK (2.19+)
- Convex account / project setup
- Tenants are provisioned per venue with region-aware configurations (currency, tax rules).
- Multi-environment setup: `production`, `staging`, `sandbox` for demos.
- Automated backups and migration scripts maintained in the `infra/` directory of the main repository.

### Quick start
## Roadmap

1. Clone the repository
| Milestone | Description | Status |
| --- | --- | --- |
| Analytics v1.1 | Expand dashboards with labour cost tracking and anomaly detection. | In QA |
| Loyalty 2.0 | Introduce card-linked offers and partner marketplace integrations. | Development |
| Delivery Hub | Unified view for delivery platforms (Uber Eats, Glovo, Bolt Food). | Discovery |

```bash
git clone https://github.com/Monynha-Softwares/Boteco-Pro.git
cd boteco-pro
```

1. Install dependencies

```bash
flutter pub get
```
## Contribution workflow

1. Review open issues labelled `feature`, `bug`, or `research` before picking up work.
2. Ensure database migrations include backward-compatibility notes.
3. Add end-to-end tests for mission-critical flows (orders, reservations, loyalty redemption).
4. Provide bilingual release notes (PT/EN) summarising changes for venue managers.
52 changes: 43 additions & 9 deletions docs/projects/boteco-pt/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,53 @@
# Boteco.pt

## Description
## Overview

Boteco Pro: Complete solution for bars and restaurants.
Boteco.pt is the Portuguese marketing site for the Boteco hospitality platform. It communicates product value, captures inbound leads, and provides support resources for bar and restaurant owners evaluating Boteco Pro.

## Technologies
## Objectives

- TypeScript
- Present core modules—POS, inventory, loyalty, and analytics—in Portuguese with local pricing.
- Drive demo requests via integrated CRM forms and calendaring links.
- Highlight testimonials, partner integrations, and regulatory compliance updates.
- Offer downloadable brochures, FAQs, and help-centre entry points.

## Repository
## Audience

[GitHub: boteco.pt](https://github.com/Monynha-Softwares/boteco.pt)
- Owners and managers of bars, cafés, and small restaurant chains.
- Franchise operators comparing management software.
- Channel partners and resellers seeking co-marketing assets.

## Features
## Content & UX guidelines

- Full management system for bars and restaurants
- Integrated solutions for the hospitality sector
- Provide parity between Portuguese and English copy, prioritising accessibility (WCAG AA) and inclusive language.
- Include structured data for product, FAQ, and local business to improve SEO visibility.
- Optimise for Core Web Vitals—especially Largest Contentful Paint and Cumulative Layout Shift.
- Ensure forms support keyboard navigation and screen readers; validate inputs with clear error messaging.

## Technical implementation

- **Framework**: Next.js with static generation for marketing pages and server-side rendering for dynamic lead forms.
- **Styling**: Tailwind CSS + custom design tokens defined in `packages/ui`.
- **Integrations**: HubSpot (lead capture), Resend (transactional email), Google Tag Manager (analytics consent).
- **Hosting**: Vercel production + preview deployments from pull requests.

## Operations

- Content updates are managed through MDX sections; keep components localised under `apps/web/content`.
- For campaign-specific pages, create new routes under `/campanhas` with analytics tagging.
- Use the shared [UX Guidelines](../../guidelines/ux-guidelines.md) for motion, colour contrast, and iconography.

## Roadmap

| Initiative | Description | Status |
| --- | --- | --- |
| Case study hub | Publish success stories for Portuguese venues with video embeds. | In progress |
| Pricing calculator | Interactive ROI calculator tailored to venue size and modules. | Planned |
| Knowledge centre | Integrate support articles sourced from Freshdesk. | Planned |

## Contribution checklist

1. Review open issues tagged `website` in the main repository.
2. Coordinate with marketing for copy approval before merging changes.
3. Attach Lighthouse and axe accessibility reports to pull requests touching UI.
4. Provide localisation keys and translations for any new text strings.
45 changes: 36 additions & 9 deletions docs/projects/facodi/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,46 @@
# FACODI

## Description
## Overview

FACODI — Community Digital College — https://facodi.pt
FACODI (Faculdade Comunitária Digital) is an online learning environment offering asynchronous courses, live cohorts, and mentorship for Portuguese-speaking communities. The platform focuses on accessibility, affordability, and community-driven learning.

## Technologies
## Value proposition

- Python
- Democratise access to technology education and entrepreneurial training.
- Provide modular curricula aligned with local job market needs.
- Build a mentorship network pairing students with industry professionals.

## Repository
## Core experience

[GitHub: facodi.pt](https://github.com/Monynha-Softwares/facodi.pt)
1. **Learning paths** – Sequenced modules combining video, readings, and interactive assessments.
2. **Community spaces** – Forums, study groups, and mentor office hours with moderation tools.
3. **Certification** – Verifiable completion certificates and digital badges.
4. **Partner programs** – White-label offerings for NGOs, schools, and municipalities.

## Features
## Platform architecture

- Community educational platform
- Digital learning resources
- **Backend**: Django with PostgreSQL, leveraging Django REST Framework for APIs.
- **Frontend**: Next.js client consuming REST endpoints and rendering MDX course content.
- **Realtime**: Pusher channels for live classrooms and chat.
- **Analytics**: Metabase dashboards visualising engagement, retention, and graduation metrics.

## Compliance & accessibility

- Meets WCAG 2.1 AA with screen-reader friendly navigation and captioned media.
- Stores learner data within EU data centres and respects GDPR consent requirements.
- Implements secure exam proctoring using timed assessments and device fingerprinting.

## Roadmap

| Initiative | Goal | Status |
| --- | --- | --- |
| Mentor marketplace | Match learners with mentors using availability calendars. | Development |
| Offline access | Allow course downloads within the mobile app. | Discovery |
| Scholarship engine | Automate scholarship eligibility and onboarding. | Planned |

## Contribution guidelines

- Coordinate curriculum changes with the academic board before editing content repositories.
- Add unit tests for Django services and Playwright regression tests for key learner journeys.
- Provide Portuguese and English copy when altering UI strings.
- Document data migrations and run them against staging before requesting production deploys.
Loading