JabRef / JabRef/user-documentation

Create documentation for Systematic Literature Review (SLR)

Open
#391 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

#333 attempted to add some documentation, but never was merged, because the info is outdated.

As it stands right now, people would need to experiment with the feature or to actually look into the code.

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 by reviewing issue #333 and the current SLR implementation in the code, since the earlier documentation was not merged and is outdated. Compare the implementation with the existing user-documentation structure, then document the feature's current workflow and behavior so users no longer need to experiment or inspect the code.

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
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.