JabRef / JabRef/user-documentation

Add use-case oriented guides

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
54
Forks
142
Avg merge
23h 56m
Merged PRs (30d)
12

Description

The collection pages "Collect", "Organize", etc are currently empty. I think this is a good place to add short guides that describe different use cases. For example, under the Collect page one should answer questions like "I have the book in front of me, how do I add it?" or "I'm found an interesting article while browsing the web, how do import it into JabRef?". The desription shouldn't be too in depth, just give a brief outline how to do each action and link the later articles for more details, for example, "manually using the information on the copyright page or based on ISBN" and "using the browser extension".

See e.g mendeley guides or this article or A guide to using JabRef

Contributor guide

Open the contributing guide

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

Start with the empty "Collect" and "Organize" collection pages and review the linked Mendeley guides, article, and JabRef guide for structure and use cases. Done means each collection page has brief answers for common actions, such as adding a book manually or importing a web article, with links to more detailed articles.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.