precice / precice/precice.github.io
Show relevant citations in documentation pages
- Dominant language
- HTML
- Stars
- 31
- Forks
- 140
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
We should make citing the relevant publications as simple as possible. A good step could be to list relevant publications on documentation pages.
**Implementation**
This could be a tagging system that assigns a topic to a page and then lists a set of publications for the tag: `cpl-schemes`, `mappings`, `IQN`.
We currently need to maintain a database of publications for the literature review page. So, this could also be a list of citations in page headers.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the documentation pages and the existing literature review publication database. Compare the proposed topic-tagging approach with citations in page headers, then define which approach can list relevant publications and keep citations maintainable across pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100