Set up a documentation site
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- github, github-actions, typescript
- Ambito
- devops, documentation
Direzione di ricerca
Start by reviewing the existing guides in docs/ and the README to identify the current content and how the project is built. Then choose a static site generator and hosting approach, organize the requested topics, and add a CI build and link check. Done means the site is published from main, the README links to it, and CI fails on broken links.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Goal
A documentation site for users, self-hosters, and contributors.
Tasks
- Pick a static site generator (for example Docusaurus, VitePress, or MkDocs) and host it on GitHub Pages or similar.
- Structure: overview, quick start, configuration reference (all environment variables), GitHub App setup, comment commands (
/review,/improve,/describe,/ask), operations (backup, restore, upgrade, egress), architecture, contributing. - Move the existing guides from
docs/into the site and keep one source of truth. - Build and link check in CI.
Acceptance criteria
The site is published from main, the README links to it, and CI fails on broken links.
- Lingua principale
- TypeScript
- Stelle
- 0
- Fork
- 1
- Merge medio
- 1h 15m
- PR unite (30g)
- 217
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ExpidetGames/code-reviewer
-
area: app type: bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
ExpidetGames/code-reviewer#308 ·
I maintainer di solito rispondono entro 1 giorno
-
type: docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
ExpidetGames/code-reviewer#94 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
ExpidetGames/code-reviewer#401 ·
I maintainer di solito rispondono entro 1 giorno
-
area: app type: chore
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
ExpidetGames/code-reviewer#393 ·
I maintainer di solito rispondono entro 1 giorno
-
area: runner type: bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
ExpidetGames/code-reviewer#390 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di ExpidetGames/code-reviewer
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
anomalyco/opencode#56380 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
BUG | `MCP 服务器` | 全局层行的停用/启用与删除报 404 server row not found，编辑保存会在 profile 层复制出重复行Forse già presa @w6242652 l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
Chocobozzz/PeerTube#7832 ·
I maintainer di solito rispondono entro 3 giorni
-
Pay to use?Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 66/100
darkreader/darkreader#16108 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni