WilliamRagstad/gsh

Developer Resources

Open

#15 opened on Apr 21, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (0 forks)auto 404
documentationgood first issue

Repository metrics

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

Description

An ecosystem/DX (developer‑experience) deliverable. Shipping an official, discoverable, community‑editable SDK bundle plus documentation that helps devs build on GSH.

  • Create an /docs folder with:
 /docs
 ├─ index.md                ← high‑level intro & TOC
 ├─ awesome-gsh.md          ← curated links list (see 2)
 ├─ framebuffer.md          ← cross‑language framebuffer lib table (see 3)
 ├─ ui-and-server.md        ← recommended UI + server frameworks (see 4)
 └─ examples/
      ├─ rust/…
      ├─ python/…
      └─ cpp/…
  • Add mdBook or Docusaurus build job in CI → GitHub Pages at https://gsh.dev/docs.
  • Website
  • Awesome-GSH List
    • Curate a list of libraries, tools, and inspiration from community projects.
  • Framebuffer Rendering Libraries
    • Recommend native framebuffer renderers for common languages.
  • Curate official resources for recommended UI libraries, server frameworks, example servers, and best practices.
  • Encourage community-driven additions.

Contributor guide

Research direction
Clone the repository, examine the source code, identify key modules, and then follow the issue's instructions to create the /docs folder and its contents. Use the project's existing README and code comments to guide documentation. For the Awesome GSH list, research other projects and curate links. For the framebuffer library table, research cross language framebuffer libraries and list them with language support. For UI and server frameworks, recommend popular ones that are compatible with GSH. Finally, set up CI to build and deploy the documentation to GitHub Pages using mdBook or Docusaurus.
Tech stack
rust
Domain
documentationdeveloper experience
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.
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
GitRustMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75