search

experimentarium / times

Documentation repository for TIMES
0 stars 2 forks source link

Provide link to the best-rendering version on readthedocs? #33

Closed Antti-L closed 1 month ago

Antti-L commented 1 month ago

I have understood that the doc files may not rendering in the best way under Github, is that correct (and why is that so)?

However, as I know there is a supposedly best-rendering version somewhere out there, I have several times tried to search for it (with google), e.g.:

For some reason, I never seem to find anything 😄 , and it is hard for me to remember the correct address. Therefore, it would help (for me at least) if the link would be given here (in readme.md).

olejandro commented 1 month ago

Thanks @Antti-L! I'll look into making the site more discoverable by google. 😄 Meanwhile here is the URL that will be added by the PR referencing this issue: https://times.readthedocs.io/

Regarding markdown rendering on GitHub, I think this section describes it quite well: https://www.markdownguide.org/getting-started/#flavors-of-markdown. We are using MyST flavour in this project.

Actually, by any chance, could you take a look at this section of the docs and let me know what you think about it? Please disregard the equations at the end of the page that still don't break across the lines for now.

Antti-L commented 1 month ago

I had a brief look at that section and it looked quite good in general. I did spot a few typographic issues, such as C\~S\~ → CS and CO\~2\~ → CO2, and so some more proofreading is needed.

olejandro commented 1 month ago

Super, thanks! I've fixed those now as well. As far as I can see there are no issues with subscripts left. (I am sure there are other issues though). Hopefully will be able to get many more eyes looking at the docs to get them completely polished.