docs: adiciona documentação técnica da aplicação#1438
Merged
Conversation
Agent-Logs-Url: https://github.com/scieloorg/core/sessions/b73e9ed8-0e53-4598-97ae-20d6d3f7c133 Co-authored-by: robertatakenaka <505143+robertatakenaka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Create technical documentation for the application
docs: adiciona documentação técnica da aplicação
May 5, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adiciona um novo documento em docs/ para servir como referência técnica central do SciELO Core, consolidando arquitetura, componentes Django, serviços de infraestrutura e orientações operacionais para novos contribuidores e operadores.
Changes:
- cria
docs/documentacao-tecnica.mdcom visão geral da aplicação, arquitetura e stack - descreve os apps locais do projeto e seus papéis no domínio editorial/bibliográfico
- documenta configuração, APIs, tarefas assíncronas, i18n e fluxo local de desenvolvimento
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+158
to
+164
| - subapp `core.users` — modelo de usuário customizado (`AUTH_USER_MODEL = "users.User"`); | ||
| - `home` — páginas de entrada do Wagtail; | ||
| - `libs`, `utils`, `validators.py` — utilidades comuns (validações, helpers, | ||
| middlewares); | ||
| - `search_site` — integração de busca em nível de site; | ||
| - `mongodb.py`, `routers.py`, `forms.py` — integrações e roteadores. | ||
|
|
Comment on lines
+341
to
+344
| - Apps que expõem APIs possuem submódulo `api/`: `article`, `collection`, | ||
| `editorialboard`, `institution`, `issue`, `journal`, `location`, | ||
| `organization`, `pid_provider`, `researcher`, `vocabulary`, | ||
| `xml_validation`, `doi`. |
| | `flower` | Monitoramento das filas Celery | | ||
| | `traefik` (prod) | Proxy reverso e terminação TLS | | ||
| | `adminer` (local) | Cliente web para PostgreSQL | | ||
| | `minio` | Armazenamento de objetos (S3-compatível) | |
Comment on lines
+380
to
+381
| [`pytest.ini`](../pytest.ini)). Cada app possui seu `tests.py` (ou | ||
| arquivos `test_*.py`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que esse PR faz?
Adiciona
docs/documentacao-tecnica.mdcom a documentação técnica em português do SciELO Core, conforme solicitado na issue. O documento cobre:LOCAL_APPSemconfig/settings/base.py) com propósito e funcionalidades, agrupados por domínio: núcleo, modelagem editorial/bibliográfica, identificadores (PID/DOI), pessoas/instituições/localização, vocabulários, ingestão e validação de XML, busca, armazenamento e operação/relatóriosOnde a revisão poderia começar?
docs/documentacao-tecnica.md— único arquivo adicionado.Como este poderia ser testado manualmente?
docs/documentacao-tecnica.mdno GitHub (ou em qualquer renderizador Markdown).LOCAL_APPS(config/settings/base.py).api/,tasks.py,sources/,wagtail_hooks.py).../config/settings/base.py,../local.yml, etc.) resolvem corretamente.Algum cenário de contexto que queira dar?
O repositório não possuía um documento único que descrevesse a aplicação e seus apps de forma consolidada — apenas o
README.md(que apenas aponta para otemplate-scms) e a estrutura Sphinx emdocs/. Esta documentação serve como ponto de entrada para novos contribuidores e operadores, descrevendo a arquitetura modular orientada a apps Django/Wagtail e os serviços que compõem a stack.A relação de apps foi extraída diretamente de
config/settings/base.py(LOCAL_APPS) e os propósitos foram inferidos a partir da estrutura de cada app (modelos, controllers,sources/,api/,tasks.py, hooks Wagtail, fixtures e formatos de importação CSV).Screenshots
N/A — alteração apenas em documentação Markdown.
Quais são tickets relevantes?
Issue referenciada: "Crie documentação técnica da aplicação".
Referências
config/settings/base.py—LOCAL_APPS,INSTALLED_APPS,LANGUAGES,HAYSTACK_CONNECTIONS,REST_FRAMEWORK,SIMPLE_JWTconfig/api_router.py,config/celery_app.py,config/urls.pylocal.yml,production.yml— composição dos serviçosrequirements/base.txt— versões das dependências principais.pre-commit-config.yaml,.github/workflows/ci.yml,pytest.ini— ferramentas de qualidade