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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#79 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
72/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
css, html, javascript
Domaine
documentation, frontend

Piste de recherche

Commence par README.md lignes 121-125, 161 et 169, et vérifie les affirmations par rapport au jeu en ligne et à index.html:30-51, qui contient les barres de pièces capturées. Le sélecteur de promotion est décrit à la ligne 72 du même fichier. C'est terminé lorsque les deux captures d'écran dans assets/screenshots/ montrent la mise en page actuelle avec la légende mise à jour, que les lignes 161 et 169 correspondent au comportement et que npm run format réussit.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
4
Forks
2
Merge moyen
4 h 8 min
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Static_Chess

Toutes les issues de TMHSDigital/Static_Chess

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.