JuliaAI / JuliaAI/MLJ

Make citation easier to find

Open
#39 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Svelte
Stars
3
Forks
0
Avg merge
1h 50m
Merged PRs (30d)
2

Description

I think MLJ's citation could be made easier to find.

The name BIBLIOGRAPHY is a bit misleading as it could mean 'works used by us' not 'how to cite our work'.

I got a bit lost between the website, the website's repo, the docs, and the doc's repo.

  • Could be made clearer in the readme of both repos (See Flux's )
  • Could add the doi somewhere visible on the website (About section, or the footer at Home)?

I understand this is a huge ecosystem and proper citation of all tools used is hard. But gotta start somewhere!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the README materials for both repositories and the website's About or footer locations, using Flux's README as a reference. First locate the existing BIBLIOGRAPHY and citation or DOI information; done means a newcomer can find clear citation guidance and the DOI from the README and website.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.