search

ukri-excalibur / excalibur-tests

Performance benchmarks and regression tests for the ExCALIBUR project
https://ukri-excalibur.github.io/excalibur-tests/
Apache License 2.0
18 stars 15 forks source link

Documentation Update #279

Closed tkoskela closed 5 months ago

tkoskela commented 6 months ago

I've converted the documentatioin that was in README.md, CONTRIBUTING.md and SYSTEMS.md into a github.io website with mkdocs. I've done some reformatting and reorganisation of the sections to make the navigation more logical to me. I've also removed the other files from the root of the repository and shortened README.md to just contain a short header and links to the website.

There's one limitation I've come across. Mkdocs can only build the website out of files in the docs/ directory. So I had to add links to apps/ and post-processing/ in docs/ to be able to link in the markdown files in them. This approach is suggested by mkdocs e.g. here

tkoskela commented 5 months ago

TODO:

tkoskela commented 5 months ago

Looks pretty good for the most part, but as discussed yesterday there are still a few formatting issues and hiccups with missing pages. Specifically:

  • Supported Benchmarks > Synthetic Benchmarks - All have list formatting issues.
  • Supported Benchmarks > Mini-apps > hpgmg - Missing README.
  • Supported Benchmarks > Mini-apps > sombrero - List formatting issues.
  • Supported Benchmarks > Applications > swift - Missing README.
  • Supported Systems - It's a bit annoying that the right menu collapses whenever you click a sub-category, but otherwise not a big deal.
  • ARCHER2 Tutorial - Various formatting issues, particularly when displaying bash output.

I've added the missing pages and fixed the formatting issues you found @pineapple-cat, and the most obvious ones I could find in the ARCHER2 tutorial. Thanks to @giordano suggestions you can see a preview of the deployed website here