How do I properly add newly generated docs to mruby.github.io?
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- SCSS
- Estrelas
- 26
- Forks
- 32
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
The last bit of documentation I wrote was approved of and merged by @matz into mruby. Now I want to add the documentation to mruby.org. Usually what would happen is that I'd generate the doc using mruby-yard. In this case, the only thing that changed was that I added docs to string.h. So I'd then take the generated doc in this case a file called mruby_2Fstring.h.html. Then I'd just copy and paste it to the proper directory in mruby.github.io then I'd do a PR. Of course, if it's merged it would then go live. Is that still okay? Because I remember before @zzak said that the size was too big. I want to make sure I do this correctly this time!
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando a página gerada mruby_2Fstring.h.html, o caminho de geração do mruby-yard e o layout existente do mruby.github.io. Leia o PR #39 anterior sobre a preocupação com o tamanho e, em seguida, confirme o processo atual de publicação com os mantenedores. Considera-se concluído quando houver um procedimento acordado e, se solicitado, um PR seguindo esse procedimento.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- ruby
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Pouca atividade
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 35/100