Skip to content

Commit

Permalink
Improve the left sidebar structure
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelosinnerworkings committed Jun 28, 2024
1 parent 77079ac commit 0ff6fb9
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 38 deletions.
File renamed without changes.
27 changes: 0 additions & 27 deletions docs/docs/como_funciona/index.md

This file was deleted.

8 changes: 8 additions & 0 deletions docs/docs/como_funciona/intro_funcionamento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Como funciona

Nesta seção, você encontrará as seguintes informações sobre o Ro-DOU:

* Compreendendo melhor a pesquisa no Diário Oficial da União
* Recursos e funcionalidades
* Parâmetros de pesquisa disponíveis
* Exemplos de configuração do arquivo YAML
4 changes: 3 additions & 1 deletion docs/docs/como_funciona/operadores.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Operadores de Pesquisa Avançada

# TODO
Nesta seção, você encontrará informações sobre os operadores de pesquisa avançada no Ro-DOU.

Esta seção ainda está em desenvolvimento e será disponibilizada em breve.
7 changes: 7 additions & 0 deletions docs/docs/como_funciona/pesquisa_dou.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Compreendendo melhor a pesquisa no Diário Oficial da União

Todos os parâmetros disponíveis para pesquisa no Diário Oficial da União (DOU) foram criados a partir da API da Imprensa Nacional, que por sua vez é utilizada pelo buscador oficial do DOU em <https://www.in.gov.br/consulta/>.

Assim, é possível notar que o Ro-DOU consegue automatizar todo, ou quase todo, tipo de pesquisa que pode ser feita no site do Diário Oficial da União. A imagem abaixo é o painel de pesquisa avançada do site:

![Captura de tela do painel de pesquisa avançada no site do DOU.](https://github.com/gestaogovbr/Ro-dou/blob/main/docs/img/parametros-pesquisa-avancada-dou.png?raw=true)
9 changes: 9 additions & 0 deletions docs/docs/como_funciona/recursos_funcionalidades.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Recursos e funcionalidades

O Ro-DOU possui os seguintes recursos e funcionalidades voltados aos usuários:

- Resultados com frequências **diária**, **semanal** ou **mensal**;
- Relatórios em formato `.CSV` para facilitação do uso;
- Busca dinâmica das palavras-chaves de um **banco de dados** ou de uma **variável**;
- Pesquisa em **seção** específica do diário oficial;
- Envio de notificações para os canais existentes no Discord e no Slack.
File renamed without changes.
File renamed without changes.
22 changes: 12 additions & 10 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,26 @@ nav:
- Página Inicial: index.md
- O que é Ro-DOU?: rodou.md
- Como utilizar:
- Introdução: como_utilizar/index.md
- Instalação:
- Instalação: como_utilizar/instalacao/instalacao.md
- Notificação de Erros: como_utilizar/instalacao/notificacao_de_erros.md
- Introdução: como_utilizar/intro_utilizacao.md
- Instalação e configuração: como_utilizar/instalacao.md
- Usuários internos e externos: como_utilizar/usuarios.md
- Notificação de erros: como_utilizar/notificacao_de_erros.md
- Como funciona:
- Introdução: como_funciona/index.md
- Introdução: como_funciona/intro_funcionamento.md
- Compreendendo a pesquisa no D.O.U.: como_funciona/pesquisa_dou.md
- Recursos e funcionalidades: como_funciona/recursos_funcionalidades.md
- Parâmetros de pesquisa: como_funciona/parametros.md
- Operadores de pesquisa avançada: como_funciona/operadores.md
- Exemplos: como_funciona/exemplos/exemplos.md
- Exemplos: como_funciona/exemplos.md
- Como contribuir:
- contribuicoes.md
- Contribuições: contribuicoes.md
- Oficinas e mídias:
- midias.md
- Conteúdos sobre o Ro-DOU: midias.md
- Outros:
- faq.md
- FAQ: faq.md
- Links relevantes: links.md
- Contato: contato.md
- Changelog: changelog.md
- CHANGELOG: changelog.md

theme:
name: 'readthedocs'

0 comments on commit 0ff6fb9

Please sign in to comment.