fab icon indicating copy to clipboard operation
fab copied to clipboard

Documentation Update

Open hiker opened this issue 1 year ago • 2 comments

While there is a link to the documentation (top right hand of the fab github entry screen), I would usually first read the README ... and once you scroll then you can't see the link anymore. Also, it would be great to have the documentation as PDF.

  • [ ] Build a PDF of the documentation and upload it to github.io.
    • [ ] Apparently latex does not support svgs (or maybe we need another dependency??) So we might have to convert the one svg image to a png.
  • [ ] Add links to the top-level README to both the PDF and html github pages.
  • [ ] https://github.com/MetOffice/fab/wiki contains a (now?) invalid link at the very top of the pages (to the old pages I assume). Check the wiki for any other broken links.

hiker avatar Jul 25 '24 06:07 hiker

Best to keep vector graphics as vector graphics. If LaTeX extension can't be found to handle SVG then convert it to EPS.

MatthewHambley avatar Jul 31 '24 12:07 MatthewHambley

  • Agree with @MatthewHambley should we need vector graphics eps would be ideal. Better avoid third-party conversion on-the-fly.

  • GitHub Wiki is pretty much static, and outside the scope of GitHub version control which is a shame (I don't think MS listen to the users well)

Additionally,

  • [ ] Migrate https://github.com/metomi/fab-test-data -> https://github.com/MetOffice/fab-test-data ?
  • [x] Since the repo has now moved to a new org/owner, replace all instances of https://github.com/metomi and https://metomi.github.io/.. with https://github.com/MetOffice and https://metoffice.github.io/.. throughout.

yaswant avatar Sep 10 '24 16:09 yaswant