Criar página para o FAQ #1581
Criar página para o FAQ #1581
Conversation
Rafatcb
added
front
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Analisando aqui, parece que poderíamos atualizar a ordem de algumas coisas no rodapé. Hoje está assim: Pensei em agrupar numa ordem adequada de leitura, pensando no "visitante médio", deixando links externos para o fim. O que vocês acham? |
There was a problem hiding this comment.
Show @Rafatcb! 💪💪💪
Pensando nessa página ter mais uma função didática do que realmente colocar as perguntas de acordo com a frequência em que aparecem, eu dividiria o texto em mais perguntas e respostas.
E também mudaria um pouco a ordem, pois acho que antes de falar de TabCoins, é preciso falar de TabCash e, antes disso, falar o que é o TabNews e sobre os conteúdos.
Acho interessante também explicar que tanto "Publicações" como "Comentários" são tratados como "Conteúdos". E poderia utilizar apenas "conteúdos" em algumas das repetições de "publicações e/ou comentários".
Outras sugestões estão no código, mas vejam com cuidado, pois talvez nem todas façam sentido. E como não sei se será aceita a proposta de dividir em mais perguntas, acabei não dividindo tanto como eu gostaria. 😅
Será que não vale a pena usar componentes/tags HTML ao invés de Markdown? Isso trará maior flexibilidade, por exemplo com o uso de âncoras nos títulos, e menor dependência sobre o ByteMD. As âncoras como estão (com
<div>) ficam comuser-contentno id.
Para resolver os problemas citados, além de facilitar a manutenção, seja nos textos ou em mudanças de estilização, eu acho melhor criar um array de objetos com as perguntas e respostas, onde apenas as respostas podem ser escritas em markdown.
Analisando aqui, parece que poderíamos atualizar a ordem de algumas coisas no rodapé
Hoje está em ordem alfabética para facilitar a adição de itens sem se preocupar em que posição colocar.
Não vejo problemas em mudar esse critério, mas talvez seria bom deixar o novo critério documentado como comentário no código para facilitar aos contribuições que venham a adicionar novos itens.
|
@aprendendofelipe obrigado pelas sugestões. Darei uma olhada com calma final de semana, já aplicando as alterações que concordo sem precisar debater mais.
Explicar sobre o TabNews e sobre como funcionam os votos (não é "gostei" e "não gostei") são pontos importantes que faltaram, vou adicionar.
Realmente, ficará bem melhor, podendo colocar isso na pergunta que explicará sobre o TabNews.
Vou experimentar.
Ah, então eu acho melhor trocar o critério mesmo. Deixarei um comentário no código quando fizer isso. |
There was a problem hiding this comment.
Ainda precisa ajustar algumas coisas, como o conteúdo de algumas respostas e talvez a ordem das perguntas.
Adicionei uma tabela de conteúdo antes das perguntas para facilitar encontrar algo específico, já que o FAQ ficou mais extenso.
Deixei comentários específicos no código.
| }, | ||
| { | ||
| question: 'Como ganhar TabCash?', | ||
| answer: `Para ganhar TabCash, é necessário contribuir com a qualificação de conteúdos de outras pessoas, consumindo 2 TabCoins a cada qualificação realizada e, ao mesmo tempo, ganhando 1 TabCash.`, |
There was a problem hiding this comment.
Enquanto refazia o FAQ, passou pela minha cabeça que seria legal usar os identificadores de TabCoin e TabCash ao falar deles, para o leitor associar as representações, mas isso demandaria deixar de usar markdown nas respostas também.
Aqui seria um lugar legal de se ter, por exemplo.
There was a problem hiding this comment.
Dá para aceitarmos outros formatos para a resposta, mas deixaria isso como melhoria futura.
There was a problem hiding this comment.
@Rafatcb, fiz novos comentários no código.
Dessa vez não analisei as perguntas e respostas.
| }, | ||
| { | ||
| question: 'Como ganhar TabCash?', | ||
| answer: `Para ganhar TabCash, é necessário contribuir com a qualificação de conteúdos de outras pessoas, consumindo 2 TabCoins a cada qualificação realizada e, ao mesmo tempo, ganhando 1 TabCash.`, |
There was a problem hiding this comment.
Dá para aceitarmos outros formatos para a resposta, mas deixaria isso como melhoria futura.
|
Estilizei os títulos das perguntas para ficarem parecidos com como é na documentação do GitHub.
Além disso, reformulei as respostas para atender os comentários que ficaram em aberto da outra revisão do PR. |
There was a problem hiding this comment.
@Rafatcb, a implementação ficou TOP! 🚀🚀🚀
Sobre as perguntas e respostas, algumas eu acho que merecem debates maiores antes de serem inseridas no FAQ. Principalmente as que podem influenciar os comportamentos, mas também as que tentam definir algo que nunca foi bem definido anteriormente.
E acho que um debate assim não vai ocorrer na revisão do PR, e talvez nem nas issues, então estava pensando que seria interessante publicar a pergunta no próprio TabNews, explicando no corpo que o questionamento está sendo feito para basear a resposta do FAQ.
O que acha dessa ideia?
Mas muitas respostas aqui já estão ótimas, então acho que podemos selecionar algumas e já enviar o FAQ para produção, pois assim quem for contribuir nos debates terá uma visão melhor de onde as respostas criadas vão ser expostas. Ou prefere primeiro definir as respostas para as perguntas que já estão colocadas no PR antes de enviar para produção?
Eu tinha pensado algo parecido enquanto escrevia. Criar uma publicação do tipo "O que você acha que deveria estar no FAQ?". Podemos fazer isso sim, até porque concordo com você que dificilmente teríamos a discussão no repositório, ao menos em um tempo curto.
Eu concordo em deixar as que estão prontas e fazer o merge, já dá um contexto para as pessoas e evita dispersar muito a discussão. Quais você acha que deveríamos remover? |
There was a problem hiding this comment.
Criar uma publicação do tipo "O que você acha que deveria estar no FAQ?"
Eu não perguntaria isso enquanto não respondermos as perguntas que já temos. Prefiro colocar a pergunta que queremos responder e ver o que a Turma responde. Começaria com a pergunta "O que é o TabNews?". E esperaria a Turma interagir bastante antes de lançar a próxima pergunta.
Eu concordo em deixar as que estão prontas e fazer o merge, já dá um contexto para as pessoas e evita dispersar muito a discussão. Quais você acha que deveríamos remover?
Eu só acho que precisa ser removida a pergunta sobre o tipo de conteúdo. A resposta sobre o que é o TabNews pode até ficar, mas eu mudaria o texto e ID da pergunta.
O resto ficou show! 👏👏👏 Bora! 🚀🚀🚀
Sim! Aquele exemplo que eu dei eu tinha pensado logo no início do PR. Agora, concentrar numa pergunta será mais produtivo. Dependendo da pergunta pode até ser mais de uma, se o assunto for bem relacionado. |
@filipedeschamps, dada a dinâmica da conversa, não sei se você viu que a gente já tinha concordado em fazer o merge do PR praticamente como ele está. Ponto pacífico. Também chegamos a um consenso sobre a remoção de respostas que não ficaram bem definidas (são duas) e sobre a criação de publicações no TabNews para envolver a Turma na elaboração dessas respostas, e posteriormente, para outras questões. Era ponto pacífico, mas sua resposta me deixou em dúvida por este trecho:
Parece estar contrário à ideia de criar essas publicações no TabNews nesse momento. Ainda não tinha lido sobre essa ideia ou acha melhor deixar para depois? @Rafatcb, de qualquer forma, não vejo razão para adiar o que já acordamos. Após o merge, e com base na resposta de Filipe, podemos criar (você ou eu) as publicações no TabNews ou esperar por uma momento mais apropriado para complementar o FAQ. O que acha? |
Eu entendi que ele comentou especificamente sobre nossa discussão no tópico Assunto, para deixarmos como está (ao invés de tirar) e melhorarmos caso percebamos algum problema (como interpretação) ou por "carinho em querer melhorar" (aí eu consideraria que criar uma publicação para discutir é um "carinho", por exemplo).
Tudo bem. |
(cherry picked from commit 3fa9a1a)
Format questions as headings with anchors; divide the questions into more questions to become more specific. Co-authored-by: Felipe Barso <[email protected]>
|
FAQ no ar! 🚀🚀🚀 Muito obrigado @Rafatcb e @gabrielsozinho! 💪💪💪 |
|
Eu anotei um comentário que ia fazer e esqueci de publicar. Vou deixar aqui para fim de histórico.
|
Então vou colocar a culpa na Lily porque ela ta acordando a gente duas vezes por noite e eu to com Mas só reforçando, eu concordaria em fazer o merge com o parágrafo (os dois na verdade) que o @Rafatcb apontou no email, mas também acho show do jeito que foi feito o merge, pois segue o mesmo princípio do assunto nos chamar de novo quando for preciso 🤝 E sensacional o TabNews ter um FAQ 💪 Ótimo incremento ao projeto! Ainda mais com âncoras para ajudar o pessoal no dia a dia a apontar diretamente para o conteúdo em questão 😍 |
Mudanças realizadas
Esse PR é a continuação do #1210. Continuei em Markdown porque ele já estava em Markdown, provavelmente porque viu os Termos de Uso assim. Será que não vale a pena usar componentes/tags HTML ao invés de Markdown? Isso trará maior flexibilidade, por exemplo com o uso de âncoras nos títulos, e menor dependência sobre o ByteMD. As âncoras como estão (com
<div>) ficam comuser-contentno id.Abri um PR para o
CONTRIBUTING.md, então já deixei uma menção para esse arquivo na pergunta Como posso contribuir com o TabNews? no FAQ.Algumas referências usadas na criação do FAQ:
A pergunta Não consigo criar novas publicações. O que fazer? é para abordar a dúvida do issue #1540.
Tipo de mudança
Checklist: