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

Updating the documentation #1

Open
20 of 23 tasks
ttusar opened this issue Nov 10, 2023 · 2 comments
Open
20 of 23 tasks

Updating the documentation #1

ttusar opened this issue Nov 10, 2023 · 2 comments

Comments

@ttusar
Copy link

ttusar commented Nov 10, 2023

At our COCO workshop/codesprint we decided to publish the COCO documentation with Quarto. This repository will be used for prototyping, while another one will hold the scripts to produce visualizations of bbob* problems.

TODO regarding the COCO documentation:

  • Migrate from Jekyll to Quarto
  • Add a more obvious link to the bbob-biobj(-ext) visualizations
  • Update the COCO schema by adding the Rust interface
  • Add the bbob plots
  • Add heatmap/level set plots that are based on ranks instead of absolute f-values
  • Make the level sets more visible
  • Add the bbob function definitions
  • Add the bbob-mixint plots

TODO regarding the bbob-biobj(-ext) documentation:

  • Add parameters to the URL so that direct links to the "plot table" can be used
  • Fix the bug on the bbob-biobj(-ext) visualization page (only the first function is listed when all functions are chosen)
  • Fix the broken links to gforge
  • Update the information on the already published paper(s)
  • Add the bbob-biobj correlation plots
  • Fix the quarto publish issue
  • Upload all the new plots to the repository
  • How to include links to the other COCO documentation/code pages?

TODOs regarding the plots:

  • Produce all bbob plots
  • Produce all bbob-mixint plots
  • Update the bbob-biobj dominance ratio, gradient length and path length plots by using the batlowW color map
  • Update the bbob-biobj local dominance plots by using the new python script for them
  • Produce all bbob-biobj correlations plots

Other TODOs:

  • Decide how the biobjective suite is shown compared to the others
  • Merge custom.css into coco.scss?
@ttusar
Copy link
Author

ttusar commented Mar 15, 2024

Re: How to include links to the other COCO documentation/code pages?
We put the links to the top menu/bar

@ttusar
Copy link
Author

ttusar commented Mar 20, 2024

The new bbob-biobj documentation is now online, but I noticed there are some differences in how it appears using quarto preview and quarto publish. Specifically, I see two at the moment (there might be others):

  1. There seems to be a different understanding of internal vs. external links (the latter are shown with the arrow).

quarto preview (the preferred way)
image

quarto publish (to be fixed)
image

  1. Different width of the summary on the right hand side.

quarto preview (the preferred way)
image

quarto publish (to be fixed)
image

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

No branches or pull requests

1 participant