search

KATRIN-Experiment / Kassiopeia

Simulation of electric and magnetic fields and particle tracking
https://katrin-experiment.github.io/Kassiopeia/index.html
Other
47 stars 29 forks source link

Welcome page of documentation: added README.md contents #81

Closed Gon-na closed 1 year ago

Gon-na commented 1 year ago

Contents of the README.md have been added to the welcome page of the github.io welcome page.

A link to the source code has been added, the toctree hidden and the Kassiopeia logo removed, as they are displayed on the side panel.

2xB commented 1 year ago

The Table of Contents is still visible in the bar on the left?

richeldichel commented 1 year ago

The Table of Contents is still visible in the bar on the left?

Yes, but not on the welcome page. I quite like having the extended table of contents there because you do not have to manually click 4 buttons just to extend the table and access a particular subsection.

2xB commented 1 year ago

How about a dedicated "Table of Contents" page? (A dropdown certainly works as well)

2xB commented 1 year ago

Btw. I think one should also keep the link More information: Docker README from the end of the README. In the long run, that README should probably also be integrated into the documentation web page?

richeldichel commented 1 year ago

How about a dedicated "Table of Contents" page? (A dropdown certainly works as well)

I thought that it might be a bit odd to have a table of contents page also displayed in the table of contents in the sidebar. But the more I think about it, the fewer objections I have. So that might also work!

Btw. I think one should also keep the link More information: Docker README from the end of the README. In the long run, that README should probably also be integrated into the documentation web page?

I also think, that makes sense 👍