Skip to content

Conversation

@edwardchalstrey1
Copy link
Member

@edwardchalstrey1 edwardchalstrey1 commented Dec 8, 2025

@edwardchalstrey1
Copy link
Member Author

edwardchalstrey1 commented Dec 8, 2025

@tturocy @rahulsavani this is not ready for merge but it's at a point where you can comment, take a look at this new algorithms page and let me know your thoughts.

Edit: On second thoughts, I think this PR is ready, the key thing to focus on is whether my splitting of the descriptions from the CLI pages makes sense - in some cases e.g. gambit-enumpoly, I have left parts of the description that refer to command line flags on the CLI page, rather than moving along with the rest of the description to the new algorithms page.

Do we want a similar page for other algorithms than Nash (QRE, others?)

@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review December 11, 2025 09:52
@tturocy
Copy link
Member

tturocy commented Dec 11, 2025

My first reaction is that it does expose how many gaps there are in the documentation for explaining what these methods do. :). (Or maybe more to the point, it exposes that there is documentation in our gaps!!!!)

In the first instance I suppose one page with subsections/anchors seems the way to go. I would suggest our idea would be that we'd want to aim for descriptions that are no more than what would be one side of A4. For more details we would link to original papers or surveys (where appropriate) or other sources for more information (e.g. a Jupyter notebook). That would mean one HTML page would make sense I think.

@edwardchalstrey1 edwardchalstrey1 moved this from In progress to In review in Ed Chalstrey Gambit priorities Dec 11, 2025
@edwardchalstrey1 edwardchalstrey1 marked this pull request as draft December 11, 2025 14:38
@edwardchalstrey1 edwardchalstrey1 moved this from In review to To do (p1 discuss) (p2 blocked) in Ed Chalstrey Gambit priorities Dec 11, 2025
@tturocy tturocy added this to the gambit-16.6.0 milestone Dec 12, 2025
@edwardchalstrey1 edwardchalstrey1 marked this pull request as ready for review January 6, 2026 16:09
@edwardchalstrey1
Copy link
Member Author

edwardchalstrey1 commented Jan 15, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation]: Move algorithm descriptions from CLI manual pages to separate page

3 participants