spineda2019/osOS

Improve project documentation landing page

Open

#7 opened on Feb 6, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Zig (0 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

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

Description

The docs that are built by the zig build system look fantastic. That being said, I had to cobble together a "glue" page to link them (literally) all together. It currently works, but it doesn't look very pretty. This will be a long-term foal to get it looking nice (without javascript preferably)

Contributor guide

Research direction
Review the existing 'glue' page and enhance its visual design using CSS and HTML, ensuring no JavaScript is used.
Tech stack
zig
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Zig
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75