Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation & explanations #53

Open
codergeek42 opened this issue Oct 14, 2024 · 0 comments
Open

Add documentation & explanations #53

codergeek42 opened this issue Oct 14, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@codergeek42
Copy link
Owner

Minus a tiny mention in src/lib/nextWordGuesserStrategy.ts, the current documentation is...basically nonexistent other than the code being its own source of truth (which is not exactly obvious in many spots).

Acceptance Criteria:

  1. Each class and method is TSDoc documented;
  2. the README is expanded to explain the solver logic and each scoring method used;
  3. Antora docs are generated as applicable; and
  4. Clean up the more intricate/unreadable portions of solver code (use more named intermediary variables & comments, etc.).
@codergeek42 codergeek42 added the documentation Improvements or additions to documentation label Oct 14, 2024
@codergeek42 codergeek42 self-assigned this Oct 14, 2024
@codergeek42 codergeek42 linked a pull request Oct 22, 2024 that will close this issue
@codergeek42 codergeek42 removed a link to a pull request Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant