Wordle Solver Documentation
============================

A modular Python application for solving `Wordle <https://www.nytimes.com/games/wordle/index.html>`_ puzzles and playing Wordle-style games directly in your terminal.

**🔗 Source Code**: `GitHub Repository <https://github.com/raeq/wordle_solver2>`_

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage
   game_modes
   game_rules
   architecture
   api/index
   contributing
   changelog

Quick Start
-----------

Install the package and start solving Wordle puzzles:

.. code-block:: bash

   git clone https://github.com/raeq/wordle_solver2.git
   cd wordle_solver2
   pip install -e .
   wordle-solver --help

Features
--------

* **Solver Mode**: Get optimal word suggestions while playing Wordle elsewhere
* **Game Mode**: Play Wordle against the computer in your terminal
* **Advanced Algorithm**: Smart suggestions using letter frequency and word commonality
* **Multiple Strategies**: Choose from different solving strategies
* **Game History**: Track your solving performance over time
* **Rich CLI**: Beautiful terminal interface with colors and formatting

Links
-----

* **📖 Documentation**: https://raeq.github.io/wordle_solver2/
* **💻 Source Code**: https://github.com/raeq/wordle_solver2
* **🐛 Issues**: https://github.com/raeq/wordle_solver2/issues
* **💬 Discussions**: https://github.com/raeq/wordle_solver2/discussions

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`