kisp-nus/anvil

Example Cleanup and Documentation

Aberta

#44 aberto em 24 de fev. de 2025

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)OCaml (10 forks)auto 404
documentationenhancementgood first issue

Métricas do repositório

Stars
 (30 estrelas)
Métricas de merge de PR
 (Mesclagem média 2d 10h) (1 fundiu PR em 30d)

Description

The following parts:

  • Tutorial
  • Language reference
  • Library reference (after we have a standard library)

Let's just use markdown files in a docs directory, zero setup:

  • tutorial: can include tutorial Anvil code here too
  • langref
  • stdref

Guia do colaborador

Direção de pesquisa
Crie um diretório 'docs' e mova o conteúdo da documentação existente para arquivos markdown separados para tutorial, referência de linguagem e, opcionalmente, referência de biblioteca.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85