Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation footer #405

Open
fsimonis opened this issue May 7, 2024 · 2 comments
Open

Documentation footer #405

fsimonis opened this issue May 7, 2024 · 2 comments
Labels
technical Technical issues on the website

Comments

@fsimonis
Copy link
Member

fsimonis commented May 7, 2024

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:

  • Quick way to give feedback using a form: I expeced this, I missed that, I liked that
  • "Edit me" button to quickly edit the page and date of the last edit (Same as top of the page)
  • Quick link to the FAQ + discourse category based on where we are in the documentation:
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.

@fsimonis fsimonis added the technical Technical issues on the website label May 7, 2024
@MakisH
Copy link
Member

MakisH commented May 7, 2024

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:

  • complicated
  • noisy
  • and probably leave out many people that contributed to the earlier wiki

@fsimonis
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Technical issues on the website
Projects
None yet
Development

No branches or pull requests

2 participants