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
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<p align="center">
<strong>Map any repository into AI-readable context: project map, precedent index, architecture inventory, symbol index, call graph, and docs.</strong><br />
<em>Commands stay in English so they can be copied exactly.</em><br />
<a href="https://wesleysimplicio.github.io/llm-project-mapper/">Live docs: wesleysimplicio.github.io/llm-project-mapper</a>
<a href="https://wesleysimplicio.github.io/simplicio-mapper/">Live docs: wesleysimplicio.github.io/simplicio-mapper</a>
</p>

<p align="center">
Expand Down Expand Up @@ -100,7 +100,9 @@ delivery loop"]
The section below restores the project-specific README material that existed before the globalization pass. Keep this substance when refreshing the top-level narrative: add polish, do not erase operational memory.

> 🇺🇸 English. Leia em português: [README.pt-BR.md](README.pt-BR.md).
> Live docs site: [wesleysimplicio.github.io/llm-project-mapper](https://wesleysimplicio.github.io/llm-project-mapper/)
> Live docs site: [wesleysimplicio.github.io/simplicio-mapper](https://wesleysimplicio.github.io/simplicio-mapper/)
>
> The npm package name `@wesleysimplicio/llm-project-mapper` is intentionally retained for historical npm consumers; new releases ship as `simplicio-mapper` on PyPI only (see #87).

AI-friendly, stack-neutral repository scaffold. Drop it into **any** project — new or existing — and any agent CLI (Claude Code, Codex, Cursor, GitHub Copilot, Aider with Deepseek/Kimi/MiniMax/GLM, Hermes, OpenClaw) gets the context it needs to ship work the same day.

Expand Down
2 changes: 1 addition & 1 deletion README.pt-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<p align="center">
<strong>Mapeie qualquer repositório em contexto legível por IA: project map, precedent index, inventário arquitetural, símbolos, call graph e docs.</strong><br />
<em>Os comandos ficam em inglês para poder copiar exatamente.</em><br />
<a href="https://wesleysimplicio.github.io/llm-project-mapper/">Docs ao vivo: wesleysimplicio.github.io/llm-project-mapper</a>
<a href="https://wesleysimplicio.github.io/simplicio-mapper/">Docs ao vivo: wesleysimplicio.github.io/simplicio-mapper</a>
</p>

<p align="center">
Expand Down
12 changes: 6 additions & 6 deletions docs-site/docusaurus.config.cjs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const config = {
title: 'LLM Project Mapper Docs',
title: 'Simplicio Mapper Docs',
tagline: 'The docs hub for the scaffold, workflows, and agent operating model.',
url: 'https://wesleysimplicio.github.io',
baseUrl: '/llm-project-mapper/',
baseUrl: '/simplicio-mapper/',
organizationName: 'wesleysimplicio',
projectName: 'llm-project-mapper',
projectName: 'simplicio-mapper',
trailingSlash: false,
onBrokenLinks: 'throw',
onBrokenAnchors: 'warn',
Expand Down Expand Up @@ -69,7 +69,7 @@ const config = {
respectPrefersColorScheme: true,
},
navbar: {
title: 'LLM Project Mapper',
title: 'Simplicio Mapper',
items: [
{to: '/', label: 'Docs Home', position: 'left'},
{to: '/quickstart/get-going', label: 'Quickstart', position: 'left'},
Expand All @@ -78,7 +78,7 @@ const config = {
{to: '/reference/cli-flags', label: 'Reference', position: 'left'},
{type: 'docsVersionDropdown', position: 'right'},
{
href: 'https://github.com/wesleysimplicio/llm-project-mapper',
href: 'https://github.com/wesleysimplicio/simplicio-mapper',
label: 'GitHub',
position: 'right',
},
Expand Down Expand Up @@ -111,7 +111,7 @@ const config = {
{label: 'Contributing', to: '/community/contributing'},
{
label: 'Source Repo',
href: 'https://github.com/wesleysimplicio/llm-project-mapper',
href: 'https://github.com/wesleysimplicio/simplicio-mapper',
},
],
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Community",
"position": 5,
"collapsible": false,
"collapsed": false
}
203 changes: 203 additions & 0 deletions docs-site/versioned_docs/version-0.7.3/community/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
---
title: Contributing
description: Contribution workflow, review expectations, and Definition of Done.
sidebar_position: 2
---
Guia step-by-step para adicionar uma feature, fix ou refactor em `<PRODUCT_NAME>` (`<DOMAIN>`, stack `<STACK>`). Funciona pra humano e pra agent. Time: `<TEAM>`.

---

## Pré-requisitos

- Repo clonado, deps instaladas, build verde local.
- Leu `AGENTS.md` (raiz) e `.specs/architecture/PATTERNS.md`.
- Tem acesso a abrir PR e rodar CI.

---

## Fluxo padrão (8 passos)

### 1. Criar `task.md` em sprint atual

Toda mudança não-trivial nasce em `task.md`. Caminho:

```
.specs/sprints/sprint-XX/<id>-<short-desc>.task.md
```

Use `task-template.md` como base. Preencha:
- Contexto e problema.
- Acceptance Criteria testáveis (checkboxes).
- Out of scope explícito.
- Test plan (unit, integration, e2e).
- Definition of Done.
- Pegadinhas conhecidas e links.

Exemplo: `.specs/sprints/sprint-03/12-magic-link-login.task.md`.

> Mudança trivial (typo em string, bump patch sem risco, formatação) pode pular task. Mas qualquer coisa que toque comportamento, schema ou UX exige task.

### 2. Criar branch

A partir de `main` atualizada:

```bash
git checkout main
git pull --rebase origin main
git checkout -b feat/magic-link-login
```

Convenção de nome em `WORKFLOW.md` seção 1.

### 3. Implementar seguindo PATTERNS

- **Não invente padrão novo.** Se `.specs/architecture/PATTERNS.md` define como criar endpoint, componente, teste, hook, repository, siga.
- Mudou padrão? Abra ADR antes (`.specs/architecture/ADR-template.md`).
- Não adicione dependência sem confirmar com `<TEAM>` (perde aprovação técnica e onera bundle/manutenção).
- Edite só o pedido. Sem refactor oportunista. Refactor é PR separado.

### 4. Testes (unit + e2e)

Antes do PR, todo verde local:

```bash
# stack-agnostic - substitua pelo comando real do <STACK>
npm run lint
npm run test # unit + integration, cobertura >= 80%
npm run test:e2e # Playwright contra ambiente local
```

- Bug fix sem teste regressivo é **inaceitável**. Escreva teste que falha sem o fix.
- E2E tem evidência: trace, screenshot, video em `test-results/`.
- Cobertura caiu? Justifica no PR ou adiciona teste.

### 5. Abrir PR usando template

Push e abre PR via gh:

```bash
git push -u origin feat/magic-link-login
gh pr create --fill --web
```

Template em `.github/PULL_REQUEST_TEMPLATE.md` é preenchido automático. Complete:
- Link para `task.md`.
- Resumo (3-5 bullets).
- Screenshots/GIF se UI.
- Link pro report E2E (artifact CI).
- Checklist DoD marcada.
- Riscos e rollback.

Title segue Conventional Commits: `feat(auth): add magic link login`.

### 6. Review

- CI verde é pré-requisito. PR com vermelho não vai pra review.
- Reviewer humano em até 4h úteis. PR de hotfix tem SLA 30min.
- Endereça todos `req:` antes de pedir re-review.
- Discussão de design vai no diff. Discussão de arquitetura ampla vira ADR.

### 7. Merge squash

Após aprovação:

```bash
gh pr merge --squash --delete-branch
```

Mensagem squash = title do PR. Histórico de `main` fica linear e legível.

### 8. Deploy

- Merge em `main` dispara `deploy-staging.yml` automaticamente.
- Verifica smoke em staging (link no Slack pós-deploy).
- Para produção: bump versão e tag SemVer (ver `RELEASE.md`).
- Para mudanças **release-relevant** neste repositório, o padrão é fechar tudo no mesmo ciclo: npm publicado, tag GitHub criada, GitHub Release correspondente e `main` limpa/sincronizada.

### 9. Fechamento release-relevant neste repositório

Antes de considerar o trabalho encerrado, executar:

```bash
npm run lint
npm test
npm run docs:build
npm run test:e2e -- --reporter=list,html
```

Se tudo estiver verde:

```bash
# version + lockfile
npm install --package-lock-only

# publish
npm publish --access public

# tag + release
git tag -a vX.Y.Z -m "Release X.Y.Z"
git push origin vX.Y.Z
gh release create vX.Y.Z --title "vX.Y.Z" --notes-file <release-notes-file>
```

Objetivo: evitar divergência entre `package.json`, npm, tags, releases e `main`.

---

## Skills/Agents que você pode usar

Skills e agents reduzem trabalho repetitivo e enforçam padrão. Ver `.skills/` no repo.

### Skills disponíveis (em `.skills/`)

| Skill | Quando trigar | Caminho |
|-------|---------------|---------|
| `playwright-e2e` | Escrever ou ajustar teste E2E. Já tem fixtures, page objects, evidências configuradas. | `.skills/playwright-e2e/SKILL.md` |
| `conventional-commits` | Compor mensagem de commit ou title de PR. Cobre `feat`, `fix`, `chore`, breaking change. | `.skills/conventional-commits/SKILL.md` |
| `_template` | Criar nova skill pro projeto. Ponto de partida com frontmatter e seções. | `.skills/_template/SKILL.md` |

### Agents customizados (em `.agents/`)

| Agent | Uso |
|-------|-----|
| `ralph-loop.agent.md` | **Executor autônomo padrão.** Loop `read → plan → execute → lint → unit → Playwright (com evidência) → fix → repeat` até DoD verde. Aciona em toda task técnica. |
| `tdd.agent.md` | TDD specialist. Escreve teste falhando, depois código. Loop red-green-refactor. |
| `reviewer.agent.md` | Code review sem editar. Comenta padrões, sugere melhorias, valida ADRs. |
| `architect.agent.md` | Desenha arquitetura, cria ADRs, não escreve código de produção. |

> `.agents/` é a fonte canônica (padrão AGENTS.md ecosystem). Espelhado em `.github/copilot/agents/` para o GitHub Copilot Workspace. Detalhes em [`.agents/README.md`](https://github.com/wesleysimplicio/llm-project-mapper/blob/main/.agents/README.md).

### Como invocar

- Em Claude Code: `Skill(playwright-e2e)` ou referencia em prompt.
- Em Copilot Agent Mode: seleciona agent custom no chat.
- Skills com trigger explícito tem prefixo `$skill-name` em comentário ou prompt.

---

## Checklist rápido antes do PR

- [ ] `task.md` criado e linkado.
- [ ] Branch nome segue convenção.
- [ ] Build, lint, unit, e2e verdes local.
- [ ] Cobertura >= 80% (ou justificativa no PR).
- [ ] PATTERNS.md respeitado, ou ADR aberta.
- [ ] Sem dependência nova não-aprovada.
- [ ] PR title em Conventional Commits.
- [ ] Template de PR preenchido com evidências.
- [ ] Sem secrets em diff (`git diff | grep -i 'secret\|token\|key'`).
- [ ] CHANGELOG atualizado se mudança visível ao usuário.

---

## Erros comuns (não faça)

- Branch que vive 2 semanas: quebra task em pedaços menores.
- PR de 2000 linhas com "vários ajustes": split.
- Test que mocka tudo e não roda lógica real: falso verde.
- Mudar padrão sem ADR: dívida invisível.
- Force-push em branch de PR aberto: reviewer perde contexto.
- Merge com CI vermelho: bloqueia o time inteiro depois.
- Esquecer de remover feature flag concluída: lixo composto.

Em dúvida, pergunte em `<TEAM>` antes de abrir PR. Custo de pergunta < custo de revert.
37 changes: 37 additions & 0 deletions docs-site/versioned_docs/version-0.7.3/community/showcase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Showcase
description: Examples and templates for projects using LLM Project Mapper.
sidebar_position: 1
---
> Real-world projects using LLM Project Mapper. Open a PR adding your project to the table below.

## How to add yours

1. Fork this repo.
2. Add a row to the table — keep it alphabetical by project name.
3. Open a PR with title `chore(showcase): add <project-name>`.
4. PR body must answer: stack, what the agent helped you ship, any lessons learned.

We do not validate the listed projects beyond "the link works and there is some evidence the starter is in use". Best-effort.

## Projects

| Project | Stack | What it does | Author | Notes |
|---|---|---|---|---|
| _your project here_ | _e.g. Next.js + Postgres_ | _one-line description_ | [@you](https://github.com/you) | _agent CLI used_ |

## Templates

If you wrote a stack-specific template on top of the starter (a `.skills/<name>/SKILL.md`, a preset, a fork tailored for a niche) list it here:

| Template | Base stack | Maintainer |
|---|---|---|
| _none yet_ | _—_ | _—_ |

## Reviews & write-ups

Public blog posts, talks, or videos about using the starter:

| Format | Title | Author | Link |
|---|---|---|---|
| _none yet_ | _—_ | _—_ | _—_ |
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Concepts",
"position": 3,
"collapsible": false,
"collapsed": false
}
Loading
Loading