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

Use DocumenterCitations #260

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Use DocumenterCitations #260

wants to merge 5 commits into from

Conversation

lukem12345
Copy link
Member

@lukem12345 lukem12345 commented Jul 22, 2024

Currently, seven Decapodes docs pages cite scientific works. Since our docs our written in markdown, it is easy to put quickly add a link and get on with writing. Writing a references block is achieved by generating a bibliography in plain text and pasting it into markdown directly.

However, we can run into consistency errors if we remove a link but forget to also remove its bibliography entry. Further, some docs reference the same set of works, and besides repeated effort, we can run into issues if canonical links are not used for the same work. Another manual burden is collating references used across each docs page into a single references page. The manual aspect of managing bibliographies reduces the quality and scientific merit of our docs pages.

Using bibtex is the standard way to resolve this issue for scientific documentation.

So, we should centrally manage our references with bibtex via the DocumenterCitations.jl package.

@lukem12345 lukem12345 added the documentation Improvements or additions to documentation label Jul 22, 2024
@lukem12345 lukem12345 self-assigned this Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant