dclause/hermes-five

META: Rewrite and secure documentation for v0.2

Open

#28 opened on Jun 16, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (1 fork)auto 404
Plandocumentationhelp wanted

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (PR metrics pending)

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 🙏

Contributor guide

Research direction
Review the current documentation structure and identify outdated sections. Then update visuals and finalize logo as per branding guidelines.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80