Add an integrated documentation website
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Funcionalidade
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- typescript
- Domínio
- documentation, web-dev
Direção de pesquisa
Comece revisando a estrutura do repositório e o fluxo de trabalho existente do pacote TypeScript para determinar onde um site de documentação integrado poderia se encaixar. Defina a abordagem de implantação, o suporte a Markdown e snippets de código, o modelo de extensão e o escopo da landing page antes da implementação; considera-se concluído quando os forks puderem implantar e personalizar o site de documentação para seus pacotes.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
A documentation website baked into the stack so forks can:
- Deploy it for free
- Document the open-source package
- Have a way to support md and code snippets so they can showcase examples
- Allow easy extension
- Add cool landing page?
- Linguagem predominante
- TypeScript
- Estrelas
- 121
- Forks
- 11
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Sem guia de contribuição
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.
Issues semelhantes
-
Out of order / duplicate key error shows the key bytes as decimal or UTF-8, not hexTalvez já em andamento @bardrop assumiu hoje. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 86/100
-
`/leaderboard`, the page and the share image say "be the first" for a program that hasn't startedAbertabug good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
codercops/discord-bot#152 ·
Mantenedores costumam responder em até 1 dia
-
bug i18n
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
endora-commerce/endora-commerce#1315 ·
Mantenedores costumam responder em até 1 dia
-
Two stored artist rows are not act names: "DJS" from a Renate floor heading and "Stevie Cox -"Abertaarea:data-quality importer size:S
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
enorm-labs/event-junkie#5136 ·
Mantenedores costumam responder em até 1 dia
-
fix(scripts): set-device-owner.ps1 fails to parse on Windows PowerShell 5.1 (UTF-8 without BOM)Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia