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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#79 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
72/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
css, html, javascript
Bereich
documentation, frontend

Rechercherichtung

Beginne mit README.md Zeilen 121-125, 161 und 169 und prüfe die Aussagen gegen das laufende Spiel und index.html:30-51, wo die Balken für geschlagene Figuren liegen. Der Umwandlungsauswahl wird in Zeile 72 derselben Datei beschrieben. Fertig ist, wenn beide Screenshots in assets/screenshots/ das aktuelle Layout zeigen und die Bildunterschrift aktualisiert ist, Zeilen 161 und 169 zum Verhalten passen und npm run format erfolgreich durchläuft.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
JavaScript
Sterne
4
Forks
2
Ø Merge
4 Std. 8 Min.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

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

Alle Issues in TMHSDigital/Static_Chess

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

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