Skip to content

feat: add bootstrap form and rendered architecture docs - #1

Merged
jhvlima merged 70 commits into
mainfrom
test/n8n-docs
Jul 12, 2026
Merged

jhvlima merged 70 commits into
mainfrom
test/n8n-docs

Conversation

@jhvlima

@jhvlima jhvlima commented Jul 10, 2026 •

Copy link
Copy Markdown
Owner

O que mudou

  • separa o ciclo em Bootstrap e Maintenance diária
  • agrupa workflows por docs-internal + project:<slug>
  • reduz a saída a README.md, docs/architecture.mmd, workflows/*.sanitized.json e project.json
  • adiciona um formulário autenticado para selecionar projetos documentáveis
  • descobre dinamicamente os projetos pelas tags do Core
  • oculta projetos que já possuem diretório em projects/ no GitHub
  • valida novamente o slug antes de chamar o Bootstrap
  • remove o gatilho manual do Bootstrap e exige entrada de outro workflow
  • remove o gatilho manual inválido do Publisher
  • impede a Maintenance de chamar IA ou sobrescrever README.md e docs/
  • incorpora o Mermaid validado no README e referencia docs/architecture.mmd

Entrada humana

O workflow Bootstrap - Formulário de Documentação n8n é a interface oficial para a primeira documentação:

Form Trigger autenticado
  -> Core
  -> projetos já publicados no GitHub
  -> dropdown de projetos novos
  -> Bootstrap
  -> IA
  -> Publisher
  -> tela de conclusão

O formulário não expõe owner, repositório, branch nem forceBootstrap.

Estrutura gerada

projects/<slug>/
├── README.md
├── docs/
│   └── architecture.mmd
├── workflows/
│   └── <workflow>.sanitized.json
└── project.json

Validação

  • formulário e Bootstrap ativos na instância n8n
  • URL de produção exige autenticação
  • descoberta dinâmica consultou Core e GitHub
  • projetos já publicados foram removidos do dropdown
  • slug apresentado é validado antes do Bootstrap
  • seis templates importados temporariamente no n8n
  • node scripts/validate-repository.mjs
  • git diff --check
  • execução de IA 583 gerou seção, bloco Mermaid e link relativo
  • READMEs de agente-mej, carteira-invest e mvp-docs sincronizados com suas fontes .mmd

Estado operacional

  • Formulário: ativo e autenticado
  • Core: ativo
  • IA: ativa
  • Publisher: ativo como subworkflow
  • Bootstrap: ativo somente como subworkflow
  • Maintenance: ativa diariamente às 23:50 em America/Sao_Paulo

Toda saída da IA continua marcada para revisão humana.

jhvlima added 30 commits July 10, 2026 12:34
@jhvlima jhvlima changed the title docs: add portable n8n self-documentation kit feat: add bootstrap and daily maintenance for n8n docs Jul 11, 2026
@jhvlima jhvlima changed the title feat: add bootstrap and daily maintenance for n8n docs refactor: simplify n8n documentation output Jul 11, 2026
@jhvlima jhvlima changed the title refactor: simplify n8n documentation output feat: add authenticated bootstrap form for n8n docs Jul 12, 2026
@jhvlima jhvlima changed the title feat: add authenticated bootstrap form for n8n docs feat: add bootstrap form and rendered architecture docs Jul 12, 2026
@jhvlima
jhvlima marked this pull request as ready for review July 12, 2026 01:52
@jhvlima
jhvlima merged commit 19f9d2f into main Jul 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant