docs: update all documentation for post-refactor state - #14
Merged
Conversation
- Rewrite README.md: replace script-based usage with CLI interface (python -m chesscom <subcommand>), update project structure tree, add Development section (tests, lint, CI) - Update .env.template: replace all script-filename comments with the corresponding CLI subcommand names - Update DESIGN-REVIEW.md: add Section 9 'Resolution Status' table mapping all 13 actions to their PRs and test counts - Update .vscode/settings.json: remove deprecated python.linting.* and python.formatting.provider keys; replace python.pythonPath with python.defaultInterpreterPath; add [python] section with ruff formatter and on-save fix/organise-imports actions 240 tests, ruff clean.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Actions 12 + 13 — CI polish and documentation update
Action 12 (Fix GitHub Actions workflow) was fully addressed during Actions 4 and 11 —
ci.ymlhas the correct matrix (3.11/3.12), proper secret syntax, and no broken steps. No further CI changes are needed.This PR delivers Action 13: update all documentation.
Changes
README.md.env.templateDESIGN-REVIEW.md.vscode/settings.jsonpython.linting.*,python.formatting.provider,python.pythonPath; addedpython.defaultInterpreterPathand ruff formatter configVerification