Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Separate developer docs from user facing docs

Offen
#1,558 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
50/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Bereich
documentation

Rechercherichtung

Beginne damit, den Inhalt des Ordners /docs/ zu erfassen und zu ermitteln, welche Seiten sich an Hyperlight-Benutzer und welche sich an Entwickler richten. Prüfe die bestehende Dokumentationsstruktur und die Konventionen des Repositorys, bevor du die Trennung vorschlägst. Als abgeschlossen gilt die Aufgabe, wenn /docs/ ausschließlich benutzerorientierte Dokumentation enthält und die Entwicklerdokumentation einen klar getrennten Speicherort hat.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

lifecycle/confirmed

/docs/ folder contains a mix of developer docs and actual user facing docs. We should separate these so /docs/ is purely for users of hyperlight (not developers)

Vorherrschende Sprache
Rust
Sterne
4.7k
Forks
214
Ø Merge
3 T. 2 Std.
Gemergte PRs (30 T.)
32

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus hyperlight-dev/hyperlight

Alle Issues in hyperlight-dev/hyperlight

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.