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

Linkify references and add papers in readme #43

Open
2 tasks
LSYS opened this issue Sep 26, 2022 · 7 comments
Open
2 tasks

Linkify references and add papers in readme #43

LSYS opened this issue Sep 26, 2022 · 7 comments
Labels
Documentation Documentation hacktoberfest This issue welcomes contributions for Hacktoberfest.

Comments

@LSYS
Copy link
Owner

LSYS commented Sep 26, 2022

Some of the Lexical diversity/lexical richness studies have been cited in the Readme.

However, the readme.rst does not include links to these articles. Nor does the repo include those articles (pdf).

For example, McCarthy and Jarvis 2007 is not linkified in the readme. It is also not included in the repo as a pdf (preferably in the docs/literature folder). Would be nice to linkify the references and add the papers to the repo.

What's actionable: For each missing reference (e.g., McCarthy and Jarvis 2007, Šišková 2012, etc.):

  • Replace study X in the readme.rst as a hyperlink (DOIs preferred). For example, replace study X with study X <link to study>_ (see this for a guide on adding links to external web pages in .rst)
  • Add the pdf article (if freely available) to docs/literature folder (e.g. as studyX.pdf)
@LSYS LSYS added Documentation Documentation hacktoberfest This issue welcomes contributions for Hacktoberfest. labels Sep 26, 2022
@LSYS LSYS changed the title Add missing references to the Lexical diversity/lexical richness literature Linkify references and add papers in readme Sep 26, 2022
@rutvikk05
Copy link

Hello, I would like to work on this issue. Could you please assign it to me?

@Sreetama2001
Copy link
Contributor

@LSYS I am working on this issue, Could you assign me this?

@LSYS LSYS assigned Sreetama2001 and rutvikk05 and unassigned rutvikk05 Sep 27, 2022
@rutvikk05 rutvikk05 removed their assignment Sep 27, 2022
@LSYS LSYS mentioned this issue Sep 29, 2022
@Sreetama2001
Copy link
Contributor

Sreetama2001 commented Sep 30, 2022

What's actionable: For each missing reference (e.g., McCarthy and Jarvis 2007, Šišková 2012, etc.):

  • Replace study X in the readme.rst as a hyperlink (DOIs preferred). For example, replace study X with study X <link to study>_ (see this for a guide on adding links to external web pages in .rst)
  • Add the pdf article (if freely available) to docs/literature folder (e.g. as studyX.pdf)

Should I link the documents to the external page(containing the pdf ) or to the pdf directing inside the folder it is stored for e.g. docs/literature? @LSYS

@Sreetama2001
Copy link
Contributor

@LSYS I guess it is better if we add detailed citations and follow-up papers of the same in another readme.rst

@Sreetama2001
Copy link
Contributor

Sreetama2001 commented Oct 1, 2022

@LSYS can you please check the PR and add suggestions or accept it !!

@a-1an a-1an mentioned this issue Oct 1, 2022
@LSYS
Copy link
Owner Author

LSYS commented Oct 1, 2022

@Sreetama2001 can you also remove the _(1) from the siskova paper file name?

@Sreetama2001
Copy link
Contributor

@Sreetama2001 can you also remove the _(1) from the siskova paper file name?

yeah I have followed you. @LSYS

LSYS pushed a commit that referenced this issue Oct 7, 2022
… (#46)

* Linkify references to two studies (McCarthy and Jarvis 2007; Siskova 2012)
* Also add pdfs of the two studies to `./docs/`

Co-authored-by: Sreetama <[email protected]>
LSYS pushed a commit that referenced this issue Oct 29, 2022
… (#46)

* Linkify references to two studies (McCarthy and Jarvis 2007; Siskova 2012)
* Also add pdfs of the two studies to `./docs/`

Co-authored-by: Sreetama <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation hacktoberfest This issue welcomes contributions for Hacktoberfest.
Projects
None yet
Development

No branches or pull requests

3 participants