dclause/hermes-five

META: Rewrite and secure documentation for v0.2

Ouverte

#28 ouverte le 16 juin 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Rust (1 fork)auto 404
Plandocumentationhelp wanted

Métriques du dépôt

Stars
 (37 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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 🙏

Guide contributeur

Direction de recherche
Examinez la structure actuelle de la documentation et identifiez les sections obsolètes. Mettez ensuite à jour les visuels et finalisez le logo conformément aux directives de la marque.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80