README screenshots and two How to Play lines describe the old interface

Aperta Adatta ai principianti
  • Qualcosa non va?
#79 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
css, html, javascript
Ambito
documentation, frontend

Direzione di ricerca

Inizia da README.md righe 121-125, 161 e 169, e verifica le affermazioni rispetto al gioco in esecuzione e a index.html:30-51, che contiene le barre dei pezzi catturati. Il selettore di promozione è descritto alla riga 72 dello stesso file. È completato quando entrambi gli screenshot in assets/screenshots/ mostrano il layout attuale con la didascalia aggiornata, le righe 161 e 169 corrispondono al comportamento e npm run format passa.

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

Descrizione

documentation good first issue severity: low

Summary

The README's two screenshots and two "How to Play" lines describe the game as it was before the recent features and layout changes, so the README no longer matches the live site.

Where

  • README.md:121-125 (screenshots and caption)
  • README.md:161 (promotion)
  • README.md:169 (captured pieces)
  • assets/screenshots/ui-with-settings.png, assets/screenshots/ui-without-settings.png

Details

  • Screenshots. Both images were last changed on 2025-11-02. Since then index.html and the stylesheets have had 22 commits, including the Hint, Offer draw and Resign buttons, the clock, the captured-piece bars beside the board, the Load PGN and Copy FEN buttons and the folded "Settings" section (see CHANGELOG.md, Unreleased). The caption "without settings panel (left) and with settings panel (right)" refers to a layout that no longer exists.
  • Line 161 says "A pawn that reaches the last rank becomes a queen". The game shows a chooser for queen, rook, bishop or knight, as line 72 of the same file says.
  • Line 169 says the captured pieces "are shown under the Move History". They are now in a bar for each player beside the board (index.html:30-51).

Impact

Visitors deciding whether to try the game see an interface it no longer has, and two instructions that are wrong.

Suggested fix

  • Retake both screenshots from the live site, for example one of a game in progress and one with "Settings" open, and update the caption.
  • Line 161: "A pawn that reaches the last rank is promoted; choose a queen, rook, bishop or knight".
  • Line 169: say the captured pieces and the material lead are shown in each player's bar beside the board.

Acceptance criteria

  • Both screenshots show the current layout
  • Lines 161 and 169 match the game's behaviour

Related: #48

Getting started

  • Relevant files: README.md, assets/screenshots/
  • How to run tests: npm run format (Prettier checks Markdown)

Filed by repo-audit/pages-audit at 0144de7. Severity: low. Effort: S. audit-key: documentation|README.md|screenshots

Lingua principale
JavaScript
Stelle
4
Fork
2
Merge medio
4h 8m
PR unite (30g)
1

Preparare l'ambiente

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 TMHSDigital/Static_Chess

Tutte le issue di TMHSDigital/Static_Chess

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.