Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Fix documentation typos and broken links

Aperta Adatta ai principianti
#144 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, typescript
Ambito
documentation

Direzione di ricerca

L'issue elenca file specifici da modificare: docs/pelican-terminal-gap-research.md, packages/coding-agent/docs/rpc.md, SECURITY.md, packages/providers/src/api/openai-completions.ts e packages/coding-agent/src/core/compaction/compaction.ts. Inizia individuando questi file nel repository. Per ciascuno, apporta la correzione indicata: aggiorna o rimuovi i link non funzionanti, correggi i percorsi dei file e gli errori di battitura. Verifica le modifiche controllando i file modificati localmente. Fatto quando tutti i problemi elencati sono risolti e non sono stati introdotti nuovi errori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

untriaged

A docs and comments review found several problems that can confuse readers or point them to missing files:

  • docs/pelican-terminal-gap-research.md links to four comparison screenshots under pixel-art/pelican-terminal-gap-research/, but those files are not present in the repository.
  • packages/coding-agent/docs/rpc.md points to packages/agent/src/types.ts, although the current source is packages/agent-core/src/types.ts.
  • There are typos in SECURITY.md (Isuses, “non trustworthy”), packages/providers/src/api/openai-completions.ts (knwo), and packages/coding-agent/src/core/compaction/compaction.ts (settions).

Please update or remove the dead screenshot references, point the RPC guide to the current source path, and correct the spelling errors. A local audit checked 97 Markdown files and found no other broken relative links after these changes.

Lingua principale
TypeScript
Stelle
54
Fork
20
Merge medio
4h 1m
PR unite (30g)
12

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stepfun-ai/Step-Code

Tutte le issue di stepfun-ai/Step-Code

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.