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
126 changes: 44 additions & 82 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -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=<your-username>; 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/<section>/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=<username>; 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/<section>/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.
4 changes: 0 additions & 4 deletions docs/contribuicao/_category_.json

This file was deleted.

9 changes: 0 additions & 9 deletions docs/contribuicao/index.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/guias/_category_.json

This file was deleted.

9 changes: 0 additions & 9 deletions docs/guias/index.md

This file was deleted.

20 changes: 10 additions & 10 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 0 additions & 4 deletions docs/outros/_category_.json

This file was deleted.

9 changes: 0 additions & 9 deletions docs/outros/index.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/padroes/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/padroes/code-style/index.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/projects/_category_.json
Original file line number Diff line number Diff line change
@@ -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."
}
}
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions docs/projects/boteco-pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 19 additions & 0 deletions docs/projects/boteco-pt/index.md
Original file line number Diff line number Diff line change
@@ -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

19 changes: 19 additions & 0 deletions docs/projects/facodi/index.md
Original file line number Diff line number Diff line change
@@ -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

19 changes: 19 additions & 0 deletions docs/projects/monynha-com/index.md
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions docs/projects/monynha-online/index.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
- Monynha technology platform
- Tools and resources for developers
Loading