WilliamRagstad/gsh

Developer Resources

Aperta

#15 aperta il 21 apr 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Rust (0 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (3 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Clona il repository, esamina il codice sorgente, identifica i moduli chiave e poi segui le istruzioni dell'issue per creare la cartella /docs e il suo contenuto. Utilizza il README esistente del progetto e i commenti nel codice come guida per la documentazione. Per la lista Awesome GSH, ricerca altri progetti e cura i collegamenti. Per la tabella delle librerie framebuffer, ricerca librerie framebuffer cross linguaggio e elencale con il supporto linguistico. Per i framework UI e server, raccomanda quelli popolari compatibili con GSH. Infine, configura CI per costruire e distribuire la documentazione su GitHub Pages utilizzando mdBook o Docusaurus.
Tech stack
rust
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitRustMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75