Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Melhorias na Documentação da Busca Avançada #28

Closed
trevineju opened this issue Oct 20, 2022 · 6 comments
Closed

Melhorias na Documentação da Busca Avançada #28

trevineju opened this issue Oct 20, 2022 · 6 comments
Labels
docs Melhorias ou complementos à documentação good first issue Boa issue para quem está chegando hacktoberfest

Comments

@trevineju
Copy link
Member

Como o objetivo do Read the Docs é ser a documentação técnica, dos recursos do Querido Diário, seu conteúdo deve ser enxuto, expondo o suficiente para busca rápidas e localização das respostas facilmente. A referência é a documentação de Python que lista e descreve muito objetivamente para que tal comando serve (exemplo: https://docs.python.org/3/library/string.html?highlight=string#module-string)

Assim, a melhoria na página de busca avançada seria adequá-a nesse modelo de documentação técnica "tradicional".

Adicionalmente, cada operador de busca não precisa ser um subtítulo, a ponto de ficar explicitado na homepage de docs.queridodiario.ok.org.br. O título basta.
image

@ricardogando
Copy link
Contributor

ricardogando commented Oct 21, 2022

Oi @trevineju vou arrumar o formato. Obrigado.

@trevineju
Copy link
Member Author

Obrigada você!

@ricardogando
Copy link
Contributor

Oi Ju, dúvida: não preciso replicar exatamente o que está na página? É para resumir mais objetivamente.

@trevineju
Copy link
Member Author

Isso! Só listar o operador, dizer o que faz numa linha e dar um exemplo (e aí nesse caso sim pode só usar o exemplo já usado)

Na página de busca, tivemos a preocupação em explicar muito pra atingir as pessoas não técnicas, servindo como "tutorial". No read the docs, é uma documentação pra quem já programa e precisa localizar a resposta rápido.

Referenciei a docs do python na issue e pode ser bem aquilo mesmo, completamente direto.

@trevineju trevineju added docs Melhorias ou complementos à documentação good first issue Boa issue para quem está chegando hacktoberfest labels Oct 1, 2023
@ogecece
Copy link
Member

ogecece commented Apr 12, 2024

O motivo desta issue não existe mais. A documentação de busca avançada agora fica apenas no site.

@ogecece ogecece closed this as completed Apr 12, 2024
@robokbr
Copy link
Member

robokbr commented Apr 12, 2024

Traduzindo para inglês | Translating to english


The reason for this issue no longer exists. The advanced search documentation is now only on site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Melhorias ou complementos à documentação good first issue Boa issue para quem está chegando hacktoberfest
Projects
None yet
Development

No branches or pull requests

4 participants