-
Notifications
You must be signed in to change notification settings - Fork 168
Add algorithms page #682
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
base: master
Are you sure you want to change the base?
Add algorithms page #682
Conversation
|
@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. Do we want a similar page for other algorithms than Nash (QRE, others?) |
|
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. |
Uh oh!
There was an error while loading. Please reload this page.