diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 79aadb3..81ea4c6 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,84 +1,46 @@ -## Purpose - -This file provides repository-specific guidance to AI coding agents for working effectively on the Docusaurus documentation site in this repository. - -## Big Picture - -- This project is a Docusaurus v3 site (see `docusaurus.config.js`) using the classic preset. Content is organized into `docs/` (documentation) and `blog/` (posts). React UI components are in `src/`, and static assets are in `static/`. -- Primary responsibilities include running the dev server, authoring docs/blog posts (Markdown/MDX), updating UI components/styles, managing sidebar/category metadata, and building/deploying the site. - -## Key Files & Folders - -- `package.json`: Contains scripts for development (`start`), production builds (`build`), serving builds (`serve`), and deployment (`deploy`). Node >= 20 is required. -- `docusaurus.config.js`: Global site configuration (e.g., `baseUrl`, `organizationName`, `projectName`, `editUrl`, navbar/footer settings). -- `sidebars.js`: Controls the docs sidebar. Update this file when adding/moving docs or categories. -- `docs/`: Markdown/MDX documentation. Subfolders use `_category_.json` for grouping (e.g., `docs/tutorial-basics/_category_.json`). -- `blog/`: Blog posts (Markdown/MDX) with metadata in `authors.yml` and `tags.yml`. -- `src/components/`: Custom React components (e.g., `HomepageFeatures`, `TechStack`, `Portfolio`). -- `src/css/custom.css`: Global styling. Page-specific styles are in `src/pages`. -- `static/img/` and `docs/**/img/`: Image assets. Use `static/img/` for global assets and relative `./img/...` for doc-specific images. - -## Development Commands - -1. Install dependencies: - - ```powershell - yarn - ``` - -2. Run the development server (hot reload; default port 3000): - - ```powershell - yarn start - ``` - -3. Build and preview production: - - ```powershell - yarn build - yarn serve - ``` - -4. Deploy to GitHub Pages: - - ```powershell - USE_SSH=true; yarn deploy - # or without SSH - GIT_USER=; yarn deploy - ``` - -## Project-Specific Conventions & Patterns - -- **Docs Grouping**: Each `docs/` subfolder may include `_category_.json` for grouping. Update `sidebars.js` if moving docs. -- **Images**: Place global images in `static/img/` and per-doc images in `img/` next to the doc file. Reference them via `./img/foo.png` in Markdown. -- **UI Components**: Reusable components are in `src/components/`. Follow existing patterns in `src/css/custom.css` and `src/components/*/styles.module.css`. -- **MDX Usage**: Use MDX for embedding React components in docs/blogs. Examples are in `docs/` and `blog/`. - -## Integration Points & External Dependencies - -- **Docusaurus Packages**: Check `package.json` for dependencies. Avoid adding heavy runtime-only dependencies unless necessary. -- **Deployment**: GitHub Pages is the default deploy target. Ensure `organizationName` and `projectName` in `docusaurus.config.js` match the repo/org. -- **CI/CD**: No CI configuration exists. If adding CI (e.g., GitHub Actions), ensure Node >= 20 and include `yarn install && yarn build` steps. - -## Examples of Common Changes - -- **Add a Doc**: Create `docs/
/new-doc.md` (or `.mdx`) and update `sidebars.js` or rely on automatic sidebar paths. -- **Add a Blog Post**: Create `blog/YYYY-MM-DD-title.md` with YAML frontmatter (e.g., `title`, `tags`, `authors`). Update `blog/authors.yml` for new authors. -- **Edit Homepage Features**: Modify `src/components/HomepageFeatures/index.js` and `src/components/HomepageFeatures/styles.module.css`. Use `yarn start` to hot-reload. - -## Notes & Watch-Outs - -- **Node Environment**: Docusaurus config runs in Node.js. Avoid browser-specific code (e.g., `window`, `document`). -- **Version Compatibility**: The repo uses Docusaurus v3 with `future.v4: true`. Test thoroughly before upgrading to v4. -- **Testing**: No automated tests exist. Validate changes locally with `yarn build && yarn serve`. - -## Contribution Guidelines - +## MonaDocs AI Coding Agent Instructions + +This guide enables AI coding agents to work productively in the MonaDocs Docusaurus v3 documentation site. It summarizes essential architecture, workflows, and conventions unique to this codebase. + +### Big Picture Architecture +- **Docusaurus v3 Classic Preset**: Site configuration in `docusaurus.config.js`. Docs in `docs/`, blog in `blog/`, custom React UI in `src/components/`, static assets in `static/`. +- **Docs & Blog Structure**: Docs are grouped by subfolders, each with optional `_category_.json` for sidebar organization. Blog posts use Markdown/MDX with metadata in YAML frontmatter and centralized author/tag files. +- **Sidebar Management**: `sidebars.js` controls sidebar structure. Update this when adding, moving, or regrouping docs. +- **Custom UI**: Reusable React components (e.g., `HomepageFeatures`, `TechStack`, `Portfolio`) live in `src/components/`. Global styles in `src/css/custom.css`; component styles in `src/components/*/styles.module.css`. + +### Developer Workflows +- **Install dependencies**: `yarn` (Node >= 20 required) +- **Start dev server**: `yarn start` (hot reload, port 3000) +- **Build production**: `yarn build` +- **Preview build**: `yarn serve` +- **Deploy to GitHub Pages**: `USE_SSH=true; yarn deploy` or `GIT_USER=; yarn deploy` +- **No automated tests**: Validate changes by running `yarn build && yarn serve` and inspecting `build/` output. + +### Project-Specific Conventions +- **Docs Grouping**: Use `_category_.json` in each `docs/` subfolder for sidebar grouping. Always update `sidebars.js` if moving docs. +- **Images**: Place global images in `static/img/`. For doc-specific images, use an `img/` folder next to the doc and reference with `./img/foo.png`. +- **MDX Usage**: Embed React components in docs/blogs via MDX. See examples in `docs/` and `blog/`. +- **Blog Metadata**: Blog posts require YAML frontmatter (`title`, `tags`, `authors`). Add new authors to `blog/authors.yml`. + +### Integration Points & External Dependencies +- **Docusaurus Packages**: See `package.json` for dependencies. Avoid adding large runtime dependencies unless justified. +- **Deployment**: Default is GitHub Pages. Ensure `organizationName` and `projectName` in `docusaurus.config.js` match the repo. +- **CI/CD**: No CI present. If adding, use Node >= 20 and include `yarn install && yarn build`. + +### Examples of Common Changes +- **Add a Doc**: Create `docs/
/new-doc.md` or `.mdx`. Update `sidebars.js` for sidebar changes. +- **Add a Blog Post**: Create `blog/YYYY-MM-DD-title.md` with YAML frontmatter. Update `blog/authors.yml` for new authors. +- **Edit Homepage Features**: Change `src/components/HomepageFeatures/index.js` and `styles.module.css`. Use `yarn start` for hot reload. + +### Watch-Outs & Gotchas +- **Node Environment**: Docusaurus config runs in Node.js. Avoid browser-only code (`window`, `document`). +- **Version Compatibility**: Uses Docusaurus v3 with `future.v4: true`. Test thoroughly before upgrading. +- **Sidebar/Category Sync**: Always sync changes between `_category_.json` and `sidebars.js`. + +### Contribution Guidelines - Make small, testable changes per PR (e.g., add a doc, update a component). -- Include screenshots for visual changes and verify the `build/` output. -- Update `sidebars.js` or `_category_.json` if moving docs between folders. - -## Contact / Maintainer Questions +- For visual changes, verify output in `build/` and include screenshots if possible. +- Update `sidebars.js` or `_category_.json` when moving docs. -- Confirm `organizationName` and `projectName` in `docusaurus.config.js` before changing deploy settings. -- For CI configuration or GitHub Actions templates, specify the Node version and preferred publish flow. +--- +If any section is unclear or missing, please provide feedback so this guide can be improved for future AI agents. diff --git a/docs/contribuicao/_category_.json b/docs/contribuicao/_category_.json deleted file mode 100644 index 77dd622..0000000 --- a/docs/contribuicao/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Documentação para Contribuidores", - "position": 6 -} \ No newline at end of file diff --git a/docs/contribuicao/index.md b/docs/contribuicao/index.md deleted file mode 100644 index 8be94a1..0000000 --- a/docs/contribuicao/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Documentação para Contribuidores - -Esta seção contém informações sobre como contribuir com os projetos da Monynha. - -## Conteúdo em breve - -- Como contribuir -- Processo de PR -- Código de conduta diff --git a/docs/guias/_category_.json b/docs/guias/_category_.json deleted file mode 100644 index 5a18792..0000000 --- a/docs/guias/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Guias e Boas Práticas", - "position": 5 -} \ No newline at end of file diff --git a/docs/guias/index.md b/docs/guias/index.md deleted file mode 100644 index 35e29ec..0000000 --- a/docs/guias/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Guias e Boas Práticas - -Esta seção contém guias e melhores práticas para desenvolvimento na Monynha. - -## Conteúdo em breve - -- Guia de deploy -- Melhores práticas de código -- Tutoriais \ No newline at end of file diff --git a/docs/intro.md b/docs/intro.md index 2d2f3da..8910f74 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -2,17 +2,17 @@ sidebar_position: 1 --- -# Bem-vindo à Documentação da Mona +# Welcome to MonaDocs -Esta é a central de documentação da **Monynha Softwares**, contendo guias, padrões e informações sobre nossos projetos, tecnologias e processos. +This is the central documentation hub for **Monynha Softwares**, containing guides, standards, and information about our projects, technologies, and processes. -## O que você encontrará aqui +## What you'll find here -- **Projetos**: Documentação detalhada de cada projeto desenvolvido pela Mona. -- **Tecnologias**: Guias sobre as tecnologias que utilizamos. -- **Padrões Internos**: Normas de código, arquitetura e melhores práticas. -- **Guias e Boas Práticas**: Tutoriais e recomendações para desenvolvimento. -- **Documentação para Contribuidores**: Como contribuir com nossos projetos. -- **Outros Temas**: Tópicos como UX, acessibilidade e dados. +- **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. -Explore as seções no menu lateral para mais informações. +Explore the sections in the sidebar for more information. diff --git a/docs/outros/_category_.json b/docs/outros/_category_.json deleted file mode 100644 index b4f42af..0000000 --- a/docs/outros/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Outros Temas", - "position": 7 -} \ No newline at end of file diff --git a/docs/outros/index.md b/docs/outros/index.md deleted file mode 100644 index c7ee5de..0000000 --- a/docs/outros/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Outros Temas - -Esta seção contém tópicos diversos relacionados aos projetos da Monynha. - -## Conteúdo em breve - -- UX e Design -- Acessibilidade -- Dados e Analytics \ No newline at end of file diff --git a/docs/padroes/_category_.json b/docs/padroes/_category_.json deleted file mode 100644 index b70cf32..0000000 --- a/docs/padroes/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Padrões Internos", - "position": 4 -} \ No newline at end of file diff --git a/docs/padroes/code-style/index.md b/docs/padroes/code-style/index.md deleted file mode 100644 index 03713f8..0000000 --- a/docs/padroes/code-style/index.md +++ /dev/null @@ -1,23 +0,0 @@ -# Estilo de Código - -## Convenções Gerais - -- Use camelCase para variáveis e funções em JavaScript/TypeScript. -- Use PascalCase para classes e componentes. -- Indentação: 2 espaços. -- Linhas não devem exceder 80 caracteres. - -## TypeScript Específico - -- Sempre use tipos explícitos para parâmetros e retornos de função. -- Evite `any`; use tipos específicos. - -## Flutter/Dart - -- Use snake_case para nomes de arquivos. -- Seguir as convenções do Dart. - -## Ferramentas - -- ESLint para JavaScript/TypeScript -- Dartfmt para Dart \ No newline at end of file diff --git a/docs/projects/_category_.json b/docs/projects/_category_.json index c2b01dc..4ad7d4f 100644 --- a/docs/projects/_category_.json +++ b/docs/projects/_category_.json @@ -1,8 +1,8 @@ { - "label": "Projects (legacy)", - "position": 99, + "label": "Projects", + "position": 2, "link": { "type": "generated-index", - "description": "LEGACY: Duplicate/legacy English project pages. Prefer /docs/projetos/* (Portuguese)." + "description": "Documentation for Monynha Softwares projects: overviews, tech stacks, and guides." } } \ No newline at end of file diff --git a/docs/projetos/artleo-creative-spaces/index.md b/docs/projects/artleo-creative-spaces/index.md similarity index 50% rename from docs/projetos/artleo-creative-spaces/index.md rename to docs/projects/artleo-creative-spaces/index.md index 80b6c19..cead2dd 100644 --- a/docs/projetos/artleo-creative-spaces/index.md +++ b/docs/projects/artleo-creative-spaces/index.md @@ -1,18 +1,19 @@ # ArtLeo Creative Spaces -## Descrição +## Description Art by Monynha -## Tecnologias Utilizadas +## Technologies - TypeScript -## Repositório +## Repository [GitHub: artleo-creative-spaces](https://github.com/Monynha-Softwares/artleo-creative-spaces) -## Funcionalidades +## Features + +- Creative and artistic spaces platform +- Platform for artistic expression -- Espaços criativos e artísticos -- Plataforma para expressão artística \ No newline at end of file diff --git a/docs/projects/boteco-pro.md b/docs/projects/boteco-pro.md index 5ad827f..3af1751 100644 --- a/docs/projects/boteco-pro.md +++ b/docs/projects/boteco-pro.md @@ -3,13 +3,13 @@ title: "Boteco Pro — Project Overview" sidebar_position: 1 --- -This page is retained for compatibility. The canonical project documentation now lives under the Portuguese `projetos` section. +This compatibility page points to the canonical project documentation under the `projects` section. Please visit the canonical page for Boteco Pro: -[Boteco Pro — Página principal](/docs/projetos/boteco-pro) +[Boteco Pro — Project Page](/docs/projects/boteco-pro) -If you maintain docs links that point to `/docs/projects/*`, consider updating them to `/docs/projetos/*`. +If you maintain docs links that point to `/docs/projetos/*`, consider updating them to `/docs/projects/*`. ### Planned diff --git a/docs/projects/boteco-pt/index.md b/docs/projects/boteco-pt/index.md new file mode 100644 index 0000000..69cbb2e --- /dev/null +++ b/docs/projects/boteco-pt/index.md @@ -0,0 +1,19 @@ +# Boteco.pt + +## Description + +Boteco Pro: Complete solution for bars and restaurants. + +## Technologies + +- TypeScript + +## Repository + +[GitHub: boteco.pt](https://github.com/Monynha-Softwares/boteco.pt) + +## Features + +- Full management system for bars and restaurants +- Integrated solutions for the hospitality sector + diff --git a/docs/projects/facodi/index.md b/docs/projects/facodi/index.md new file mode 100644 index 0000000..d37ba77 --- /dev/null +++ b/docs/projects/facodi/index.md @@ -0,0 +1,19 @@ +# FACODI + +## Description + +FACODI — Community Digital College — https://facodi.pt + +## Technologies + +- Python + +## Repository + +[GitHub: facodi.pt](https://github.com/Monynha-Softwares/facodi.pt) + +## Features + +- Community educational platform +- Digital learning resources + diff --git a/docs/projects/monynha-com/index.md b/docs/projects/monynha-com/index.md new file mode 100644 index 0000000..e6d7af4 --- /dev/null +++ b/docs/projects/monynha-com/index.md @@ -0,0 +1,19 @@ +# Monynha.com + +## Description + +Monynha Softwares' institutional website — tailor-made software and AI solutions. + +## Technologies + +- TypeScript +- Next.js (likely) + +## Repository + +[GitHub: Monynha-com](https://github.com/Monynha-Softwares/Monynha-com) + +## Features + +- Institutional website +- Presentation of software and AI solutions diff --git a/docs/projects/monynha-online/index.md b/docs/projects/monynha-online/index.md new file mode 100644 index 0000000..7213833 --- /dev/null +++ b/docs/projects/monynha-online/index.md @@ -0,0 +1,18 @@ +# Monynha Online + +## Description + +https://monynha.online + +## Technologies + +- TypeScript + +## Repository + +[GitHub: MonynhaOnline-Default-Page](https://github.com/Monynha-Softwares/MonynhaOnline-Default-Page) + +## Features + +- Default online presence for Monynha +- Digital presence diff --git a/docs/projetos/monynha-tech/index.md b/docs/projects/monynha-tech/index.md similarity index 51% rename from docs/projetos/monynha-tech/index.md rename to docs/projects/monynha-tech/index.md index 89369e4..ab21bed 100644 --- a/docs/projetos/monynha-tech/index.md +++ b/docs/projects/monynha-tech/index.md @@ -1,18 +1,18 @@ # MonynhaTech -## Descrição +## Description [https://monynha.tech](https://monynha.tech) -## Tecnologias Utilizadas +## Technologies - TypeScript -## Repositório +## Repository [GitHub: MonynhaTech](https://github.com/Monynha-Softwares/MonynhaTech) -## Funcionalidades +## Features -- Plataforma tecnológica da Monynha -- Recursos e ferramentas tech \ No newline at end of file +- Monynha technology platform +- Tools and resources for developers diff --git a/docs/projetos/sweet-price/index.md b/docs/projects/sweet-price/index.md similarity index 52% rename from docs/projetos/sweet-price/index.md rename to docs/projects/sweet-price/index.md index 6e6cc71..f69b400 100644 --- a/docs/projetos/sweet-price/index.md +++ b/docs/projects/sweet-price/index.md @@ -1,18 +1,18 @@ # Sweet Price -## Descrição +## Description Supermarket price comparison app in Portugal. Currently supports: Pingo Doce and Continente supermarkets. -## Tecnologias Utilizadas +## Technologies -- (A definir) +- (TBD) -## Repositório +## Repository [GitHub: Sweet-Price](https://github.com/Monynha-Softwares/Sweet-Price) -## Funcionalidades +## Features -- Comparação de preços em supermercados portugueses -- Suporte para Pingo Doce e Continente \ No newline at end of file +- Price comparison for Portuguese supermarkets +- Support for Pingo Doce and Continente diff --git a/docs/projetos/_category_.json b/docs/projetos/_category_.json deleted file mode 100644 index 50e4af1..0000000 --- a/docs/projetos/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Projetos", - "position": 2 -} \ No newline at end of file diff --git a/docs/projetos/boteco-pro/index.md b/docs/projetos/boteco-pro/index.md deleted file mode 100644 index 19b1137..0000000 --- a/docs/projetos/boteco-pro/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# Boteco Pro - -## Descrição - -Sistema completo de gestão para bares e restaurantes com autenticação Firebase, banco de dados e interface Flutter moderna. - -## Tecnologias Utilizadas - -- Flutter (Dart) -- Firebase (Autenticação e Banco de Dados) - -## Repositório - -[GitHub: BotecoPro](https://github.com/Monynha-Softwares/BotecoPro) - -## Funcionalidades - -- Gestão de pedidos -- Autenticação de usuários -- Interface moderna para bares e restaurantes \ No newline at end of file diff --git a/docs/projetos/boteco-pt/index.md b/docs/projetos/boteco-pt/index.md deleted file mode 100644 index 3dd291f..0000000 --- a/docs/projetos/boteco-pt/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# Boteco.pt - -## Descrição - -Boteco Pro: A Solução Completa para Bares e Restaurantes - -## Tecnologias Utilizadas - -- TypeScript - -## Repositório - -[GitHub: boteco.pt](https://github.com/Monynha-Softwares/boteco.pt) - -## Funcionalidades - -- Sistema completo para gestão de bares e restaurantes -- Soluções integradas para o setor diff --git a/docs/projetos/facodi/index.md b/docs/projetos/facodi/index.md deleted file mode 100644 index 5aa6cb5..0000000 --- a/docs/projetos/facodi/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# FACODI - -## Descrição - -📝 FACODI — Faculdade Comunitária Digital — [https://facodi.pt](https://facodi.pt) - -## Tecnologias Utilizadas - -- Python - -## Repositório - -[GitHub: facodi.pt](https://github.com/Monynha-Softwares/facodi.pt) - -## Funcionalidades - -- Plataforma educacional comunitária -- Recursos digitais para aprendizagem \ No newline at end of file diff --git a/docs/projetos/monynha-com/index.md b/docs/projetos/monynha-com/index.md deleted file mode 100644 index ec0a5e3..0000000 --- a/docs/projetos/monynha-com/index.md +++ /dev/null @@ -1,19 +0,0 @@ -# Monynha.com - -## Descrição - -🌐 Monynha Softwares's institutional website — tailor-made software and artificial intelligence solutions. - -## Tecnologias Utilizadas - -- TypeScript -- Next.js (provavelmente) - -## Repositório - -[GitHub: Monynha-com](https://github.com/Monynha-Softwares/Monynha-com) - -## Funcionalidades - -- Website institucional -- Apresentação de soluções de software e IA diff --git a/docs/projetos/monynha-online/index.md b/docs/projetos/monynha-online/index.md deleted file mode 100644 index 17e51b0..0000000 --- a/docs/projetos/monynha-online/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# Monynha Online - -## Descrição - -[https://monynha.online](https://monynha.online) - -## Tecnologias Utilizadas - -- TypeScript - -## Repositório - -[GitHub: MonynhaOnline-Default-Page](https://github.com/Monynha-Softwares/MonynhaOnline-Default-Page) - -## Funcionalidades - -- Página padrão online da Monynha -- Presença digital \ No newline at end of file diff --git a/docs/technologies/ci-cd/index.md b/docs/technologies/ci-cd/index.md new file mode 100644 index 0000000..ff42f90 Binary files /dev/null and b/docs/technologies/ci-cd/index.md differ diff --git a/docs/technologies/convex/index.md b/docs/technologies/convex/index.md new file mode 100644 index 0000000..ad323da Binary files /dev/null and b/docs/technologies/convex/index.md differ diff --git a/docs/technologies/coolify/index.md b/docs/technologies/coolify/index.md new file mode 100644 index 0000000..800a67b Binary files /dev/null and b/docs/technologies/coolify/index.md differ diff --git a/docs/technologies/docker-compose/index.md b/docs/technologies/docker-compose/index.md new file mode 100644 index 0000000..d643221 Binary files /dev/null and b/docs/technologies/docker-compose/index.md differ diff --git a/docs/technologies/flutter/index.md b/docs/technologies/flutter/index.md new file mode 100644 index 0000000..611c5f7 Binary files /dev/null and b/docs/technologies/flutter/index.md differ diff --git a/docs/technologies/github-actions/index.md b/docs/technologies/github-actions/index.md new file mode 100644 index 0000000..5a6fbd0 Binary files /dev/null and b/docs/technologies/github-actions/index.md differ diff --git a/docs/technologies/typescript/index.md b/docs/technologies/typescript/index.md new file mode 100644 index 0000000..db58be4 --- /dev/null +++ b/docs/technologies/typescript/index.md @@ -0,0 +1,24 @@ +--- +title: TypeScript +--- + +## Description + +TypeScript is a superset of JavaScript that adds optional static typing. It helps catch errors earlier and improves code readability and maintainability. + +## Why we use it + +- Better maintainability +- Compile-time error detection +- Improved IDE and editor support (autocompletion, refactorings) + +## Projects that use TypeScript + +- Monynha-com +- Several web projects in this repo + +## Resources + +- [TypeScript Official Docs](https://www.typescriptlang.org/docs/) + +If you previously referenced `/docs/tecnologias/typescript`, the Portuguese content remains under that path — this English page is a compatibility stub to ensure internal links to `/docs/technologies/typescript` resolve correctly. diff --git a/docs/tecnologias/_category_.json b/docs/tecnologias/_category_.json deleted file mode 100644 index 3743b39..0000000 --- a/docs/tecnologias/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Tecnologias", - "position": 3 -} \ No newline at end of file diff --git a/docs/tecnologias/ci-cd/index.md b/docs/tecnologias/ci-cd/index.md deleted file mode 100644 index 915465a..0000000 --- a/docs/tecnologias/ci-cd/index.md +++ /dev/null @@ -1,84 +0,0 @@ -# CI/CD - -## Descrição - -Continuous Integration/Continuous Deployment (CI/CD) é uma prática de desenvolvimento que automatiza o processo de integração de código, testes e deployment de aplicações. Permite entregas frequentes e confiáveis de software. - -## Por que usamos - -- Detecção precoce de bugs e conflitos -- Deploy automatizado e consistente -- Redução de erros manuais -- Feedback rápido para desenvolvedores -- Melhoria na qualidade do código - -## Ferramentas que utilizamos - -- **GitHub Actions**: Para CI/CD integrado ao GitHub -- **Coolify**: Para deployment self-hosted -- **Docker**: Para containerização e ambientes consistentes - -## Pipeline típico - -### 1. Continuous Integration - -- Build automático do código -- Execução de testes automatizados -- Análise de qualidade (linting, cobertura) -- Verificação de segurança - -### 2. Continuous Deployment - -- Deploy automático para staging -- Testes de integração -- Deploy para produção -- Monitoramento e rollback - -## Exemplo de workflow - -```yaml -name: CI/CD Pipeline - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Run tests - run: npm test - - deploy-staging: - needs: test - if: github.ref == 'refs/heads/main' - runs-on: ubuntu-latest - steps: - - name: Deploy to staging - run: # comandos de deploy - - deploy-production: - needs: deploy-staging - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - runs-on: ubuntu-latest - steps: - - name: Deploy to production - run: # comandos de deploy -``` - -## Boas práticas - -- Mantenha pipelines rápidos (< 10 minutos) -- Use cache para dependências -- Implemente testes em paralelo -- Configure notificações de falha -- Documente processos de rollback - -## Recursos - -- [Guia de CI/CD](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) -- [Práticas de CI/CD](https://martinfowler.com/articles/continuousIntegration.html) \ No newline at end of file diff --git a/docs/tecnologias/convex/index.md b/docs/tecnologias/convex/index.md deleted file mode 100644 index 0105eea..0000000 --- a/docs/tecnologias/convex/index.md +++ /dev/null @@ -1,46 +0,0 @@ -# Convex - -## Descrição - -Convex é uma plataforma backend-as-a-service que permite construir aplicações reativas com sincronização de dados em tempo real. Ele fornece uma base de dados integrada, autenticação e APIs para desenvolvimento rápido de aplicações full-stack. - -## Por que usamos - -- Sincronização automática de dados entre cliente e servidor -- Desenvolvimento rápido sem gerenciar infraestrutura -- Suporte nativo para React e outras frameworks -- Escalabilidade automática - -## Projetos que utilizam - -- (A definir - projetos que usam Convex) - -## Como usar - -### Instalação - -```bash -npm install convex -``` - -### Configuração básica - -```javascript -import { ConvexProvider } from "convex/react"; -import { ConvexReactClient } from "convex/client"; - -const convex = new ConvexReactClient(process.env.CONVEX_URL); - -function App() { - return ( - - {/* Seu app */} - - ); -} -``` - -## Recursos - -- [Documentação Oficial](https://docs.convex.dev) -- [Convex Dashboard](https://dashboard.convex.dev) \ No newline at end of file diff --git a/docs/tecnologias/coolify/index.md b/docs/tecnologias/coolify/index.md deleted file mode 100644 index 547a991..0000000 --- a/docs/tecnologias/coolify/index.md +++ /dev/null @@ -1,39 +0,0 @@ -# Coolify - -## Descrição - -Coolify é uma plataforma de deployment self-hosted que permite fazer deploy de aplicações web, bancos de dados e serviços em servidores próprios. Ele suporta múltiplas linguagens e frameworks, oferecendo uma interface amigável para gerenciamento de infraestrutura. - -## Por que usamos - -- Controle total sobre a infraestrutura -- Deploy automatizado de aplicações -- Suporte para múltiplas stacks tecnológicas -- Interface web intuitiva para gerenciamento -- Alternativa open-source ao Heroku/Vercel - -## Projetos que utilizam - -- (Projetos que fazem deploy via Coolify) - -## Como usar - -### Instalação - -Coolify pode ser instalado em um servidor Ubuntu/Debian: - -```bash -curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash -``` - -### Deploy básico - -1. Conecte seu repositório Git -2. Configure as variáveis de ambiente -3. Escolha o tipo de aplicação (Node.js, PHP, etc.) -4. Faça deploy automático - -## Recursos - -- [Documentação Oficial](https://coolify.io/docs) -- [GitHub Repository](https://github.com/coollabsio/coolify) \ No newline at end of file diff --git a/docs/tecnologias/docker-compose/index.md b/docs/tecnologias/docker-compose/index.md deleted file mode 100644 index 22df0bd..0000000 --- a/docs/tecnologias/docker-compose/index.md +++ /dev/null @@ -1,68 +0,0 @@ -# Docker Compose - -## Descrição - -Docker Compose é uma ferramenta para definir e executar aplicações Docker multi-container. Permite descrever uma aplicação completa (serviços, redes, volumes) em um arquivo YAML e gerenciá-la com comandos simples. - -## Por que usamos - -- Orquestração de múltiplos containers -- Desenvolvimento local consistente -- Facilita setup de ambientes complexos -- Versionamento de configurações de infraestrutura - -## Projetos que utilizam - -- (Projetos que usam Docker Compose para desenvolvimento/local) - -## Como usar - -### Arquivo docker-compose.yml básico - -```yaml -version: '3.8' -services: - app: - build: . - ports: - - "3000:3000" - environment: - - NODE_ENV=development - volumes: - - .:/app - - /app/node_modules - - db: - image: postgres:13 - environment: - POSTGRES_PASSWORD: password - volumes: - - postgres_data:/var/lib/postgresql/data - -volumes: - postgres_data: -``` - -### Comandos comuns - -```bash -# Iniciar serviços -docker-compose up - -# Iniciar em background -docker-compose up -d - -# Parar serviços -docker-compose down - -# Ver logs -docker-compose logs - -# Reconstruir e iniciar -docker-compose up --build -``` - -## Recursos - -- [Documentação Oficial](https://docs.docker.com/compose/) -- [Guia de Início Rápido](https://docs.docker.com/compose/gettingstarted/) \ No newline at end of file diff --git a/docs/tecnologias/flutter/index.md b/docs/tecnologias/flutter/index.md deleted file mode 100644 index 12606cb..0000000 --- a/docs/tecnologias/flutter/index.md +++ /dev/null @@ -1,19 +0,0 @@ -# Flutter - -## Descrição - -Flutter é um framework de UI do Google para criar aplicações nativas compiladas para mobile, web e desktop a partir de uma única base de código. - -## Por que usamos - -- Desenvolvimento cross-platform -- Interface nativa -- Hot reload para desenvolvimento rápido - -## Projetos que utilizam - -- BotecoPro - -## Recursos - -- [Documentação Oficial](https://flutter.dev/docs) \ No newline at end of file diff --git a/docs/tecnologias/github-actions/index.md b/docs/tecnologias/github-actions/index.md deleted file mode 100644 index 6d7955a..0000000 --- a/docs/tecnologias/github-actions/index.md +++ /dev/null @@ -1,64 +0,0 @@ -# GitHub Actions - -## Descrição - -GitHub Actions é uma plataforma de CI/CD integrada ao GitHub que permite automatizar workflows de desenvolvimento, incluindo build, teste, deploy e outras tarefas automatizadas. - -## Por que usamos - -- Integração nativa com repositórios GitHub -- Workflows baseados em eventos (push, PR, releases) -- Grande ecossistema de actions pré-construídas -- Execução gratuita para projetos open source -- Controle de versão dos workflows - -## Projetos que utilizam - -- MonaDocs (este projeto usa GitHub Actions para CI) - -## Como usar - -### Workflow básico (.github/workflows/ci.yml) - -```yaml -name: CI - -on: - push: - branches: [ main, dev ] - pull_request: - branches: [ main, dev ] - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version: '20' - cache: 'yarn' - - - name: Install dependencies - run: yarn install --frozen-lockfile - - - name: Run tests - run: yarn test - - - name: Build - run: yarn build -``` - -### Actions comuns - -- `actions/checkout@v4` - Checkout do código -- `actions/setup-node@v4` - Setup Node.js -- `actions/upload-artifact@v4` - Upload de artefatos -- `actions/deploy-pages@v4` - Deploy para GitHub Pages - -## Recursos - -- [Documentação Oficial](https://docs.github.com/en/actions) -- [Marketplace de Actions](https://github.com/marketplace?type=actions) \ No newline at end of file diff --git a/docs/tecnologias/typescript/index.md b/docs/tecnologias/typescript/index.md deleted file mode 100644 index 0f80c48..0000000 --- a/docs/tecnologias/typescript/index.md +++ /dev/null @@ -1,20 +0,0 @@ -# TypeScript - -## Descrição - -TypeScript é uma linguagem de programação que é um superconjunto de JavaScript, adicionando tipagem estática opcional. - -## Por que usamos - -- Melhor manutenção de código -- Detecção de erros em tempo de desenvolvimento -- Melhor suporte a IDEs - -## Projetos que utilizam - -- Monynha-com -- Vários outros projetos web - -## Recursos - -- [Documentação Oficial](https://www.typescriptlang.org/docs/) \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index cfbb118..a30e1b6 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -11,7 +11,7 @@ import {themes as prismThemes} from 'prism-react-renderer'; /** @type {import('@docusaurus/types').Config} */ const config = { title: 'MonaDocs', - tagline: 'Documentação Central da Monynha Softwares', + tagline: 'Central Documentation Hub for Monynha Softwares', // Use an SVG favicon for crisp rendering on modern browsers // If you need .ico for legacy support, add `static/img/favicon.ico` and update this line. favicon: 'img/favicon.svg', @@ -94,26 +94,25 @@ const config = { // Explicit dropdown exposing main documentation areas so the mobile menu // shows all relevant links (projects, technologies, guidelines, etc.). { - label: 'Documentação', + label: 'Documentation', position: 'left', items: [ - { to: '/docs/intro', label: 'Introdução' }, - { to: '/docs/projetos/boteco-pro', label: 'Projetos' }, - { to: '/docs/technologies/frontend-stack', label: 'Tecnologias' }, + { to: '/docs/intro', label: 'Introduction' }, + { to: '/docs/technologies/frontend-stack', label: 'Technologies' }, { to: '/docs/guidelines/ux-guidelines', label: 'Guidelines' }, - { to: '/docs/identity/brand-guidelines', label: 'Identidade' }, - { to: '/docs/contribution/contributing', label: 'Contribuição' }, - { to: '/docs/architecture/backend-architecture', label: 'Arquitetura' }, + { to: '/docs/identity/brand-guidelines', label: 'Identity' }, + { to: '/docs/contribution/contributing', label: 'Contribution' }, + { to: '/docs/architecture/backend-architecture', label: 'Architecture' }, ], }, { to: '/blog', label: 'Blog', position: 'left' }, { - label: 'Empresa', + label: 'Company', position: 'right', items: [ { label: 'Monynha.com', href: 'https://monynha.com' }, - { label: 'Projetos', href: 'https://monynha.com/projetos' }, - { label: 'Portfólio', href: 'https://marcelo.monynha.com/portifolio' }, + { label: 'Projects', href: 'https://monynha.com/projetos' }, + { label: 'Portfolio', href: 'https://marcelo.monynha.com/portifolio' }, ], }, { @@ -127,41 +126,41 @@ const config = { style: 'dark', links: [ { - title: 'Documentação', + title: 'Documentation', items: [ { - label: 'Introdução', + label: 'Introduction', to: '/docs/intro', }, { - label: 'Projetos', - to: '/docs/projetos/boteco-pro', + label: 'Projects', + to: '/docs/projects/boteco-pro', }, { - label: 'Tecnologias', - to: '/docs/tecnologias/typescript', + label: 'Technologies', + to: '/docs/technologies/typescript', }, ], }, { - title: 'Empresa', + title: 'Company', items: [ { label: 'Monynha.com', href: 'https://monynha.com', }, { - label: 'Projetos', + label: 'Projects', href: 'https://monynha.com/projetos', }, { - label: 'Portfólio', + label: 'Portfolio', href: 'https://marcelo.monynha.com/portifolio', }, ], }, { - title: 'Comunidade', + title: 'Community', items: [ { label: 'Blog', @@ -178,7 +177,7 @@ const config = { ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} Monynha Softwares. Construído com Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} Monynha Softwares. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, diff --git a/sidebars.js b/sidebars.js index 74552ae..0db5c50 100644 --- a/sidebars.js +++ b/sidebars.js @@ -20,20 +20,20 @@ const sidebars = { 'intro', { type: 'category', - label: 'Projetos', + label: 'Projects', link: { type: 'generated-index', - description: 'Documentação dos projetos Monynha (visões gerais, stacks e guias).', + description: 'Documentation for Monynha Softwares projects: overviews, tech stacks, and guides.', }, items: [ - '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' + 'projects/boteco-pro', + 'projects/artleo-creative-spaces/index', + 'projects/boteco-pt/index', + 'projects/facodi/index', + 'projects/monynha-com/index', + 'projects/monynha-online/index', + 'projects/monynha-tech/index', + 'projects/sweet-price/index' ] }, { diff --git a/src/components/Portfolio/index.js b/src/components/Portfolio/index.js index 3bc50bb..2c483fb 100644 --- a/src/components/Portfolio/index.js +++ b/src/components/Portfolio/index.js @@ -9,7 +9,7 @@ const projects = [ description: 'Sistema completo de gestão para bares e restaurantes com controle de pedidos, estoque e financeiro.', technologies: ['Flutter', 'TypeScript', 'Convex'], status: 'Em Desenvolvimento', - link: '/docs/projetos/boteco-pro', + link: '/docs/projects/boteco-pro', icon: '🍺', color: '#FF6B35' },