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

Aberta Para iniciantes
  • Algo errado?
#79 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
css, html, javascript
Domínio
documentation, frontend

Direção de pesquisa

Comece por README.md linhas 121-125, 161 e 169, e confira as afirmações contra o jogo em execução e em index.html:30-51, que contém as barras de peças capturadas. O seletor de promoção está descrito na linha 72 do mesmo arquivo. Está concluído quando as duas capturas de tela em assets/screenshots/ mostram o layout atual com a legenda atualizada, as linhas 161 e 169 correspondem ao comportamento e npm run format passa.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
JavaScript
Estrelas
4
Forks
2
Merge médio
4h 8min
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/Static_Chess

Todas as issues de TMHSDigital/Static_Chess

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.