dclause/hermes-five

META: Rewrite and secure documentation for v0.2

Aberta

#28 aberto em 16 de jun. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Rust (1 fork)auto 404
Plandocumentationhelp wanted

Métricas do repositório

Stars
 (37 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Motivation: Writing clear, maintainable, and up-to-date documentation is hard but essential. This issue serves as a tracking task for the documentation overhaul in preparation for the upcoming v0.2 release.

Objectives:

  • #6
  • Audit current documentation content
    • Identify outdated sections, missing topics, and inconsistencies
  • Update visuals to match new branding
    • dark blue: #30475E
    • light blue: #0097A7 => lighten: #CBDDE1
    • orange: #FFAB40 => lighten: #FFE2CE
  • Review / finalize the new logo
    • Export in both SVG and PNG (consider light/dark variants)

Contributions welcome! Whether it's feedback, proofreading, or helping with new content, feel free to jump in ! Even small contributions make a big difference 🙏

Guia do colaborador

Direção de pesquisa
Revise a estrutura atual da documentação e identifique seções desatualizadas. Em seguida, atualize os visuais e finalize o logotipo de acordo com as diretrizes da marca.
Pilha de tecnologia
rust
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
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.
80