precice / precice.github.io

The website of preCICE
https://precice.org/
12 stars 59 forks source link

Documentation footer #405

Open fsimonis opened 4 months ago

fsimonis commented 4 months ago

In addition to the edit me button at the top of the page and the general information in the footer, it may also be useful to have an additional documentation footer similar to the one on GitHub.

This is an extension of #46

Content:

Documentation Section Discourse Category
Fundamentals Is preCICE for me?
Installation Installing preCICE
Configuration Using preCICE
Tooling ?
Provided adapters Official adapters and tutorials
Couple your code Using preCICE
Running simulations Using preCICE
Dev docs hide
Documentation meta hide

Example GitHub footer

Note: The suggestion is supposed to be less busy

image

image

Extra

Something similar may be useful for the tutorials too. This is supposed to go above the normal footer.

MakisH commented 4 months ago

I like it! And I think we would put exactly the same in the tutorials section.

As an additional motivation for contributing, we could also include all usernames that have edited a page at the bottom, although that would be:

fsimonis commented 4 months ago

include all usernames that have edited a page

This would look a bit weird as the same names would repeat over and over. Also, git gives you an email address, which still needs to be looked up for a username via the GitHub API, which is rate-limited, meaning it likely needs to be cached. Sounds like a complex feature.