precice / precice/precice.github.io

Documentation footer

Open
#405 3 comments 2 reactions 0 assignees View on GitHub
technical
Dominant language
HTML
Stars
31
Forks
140
Avg merge
1d 23h
Merged PRs (30d)
6

Description

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](https://precice.discourse.group/tag/faq) + discourse category based on where we are in the documentation:

Documentation Section | Discourse Category
--- | ---
[Fundamentals](https://precice.org/configuration-acceleration.html#) | Is preCICE for me?
[Installation](https://precice.org/configuration-acceleration.html#) | Installing preCICE
[Configuration](https://precice.org/configuration-acceleration.html#) | Using preCICE
[Tooling](https://precice.org/configuration-acceleration.html#) | ?
[Provided adapters](https://precice.org/configuration-acceleration.html#) | Official adapters and tutorials
[Couple your code](https://precice.org/configuration-acceleration.html#) | Using preCICE
[Running simulations](https://precice.org/configuration-acceleration.html#) | Using preCICE
[Dev docs](https://precice.org/configuration-acceleration.html#) | _hide_
[Documentation meta](https://precice.org/configuration-acceleration.html#) | _hide_

### Example GitHub footer

_Note: The suggestion is supposed to be less busy_

![image](https://github.com/precice/precice.github.io/assets/13552216/3a3c6ddc-2baa-4f2e-8370-b01841bcd37d)

![image](https://github.com/precice/precice.github.io/assets/13552216/03f20195-0e9d-4edb-92e5-e5b251f5de2a)

### Extra

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.