JabRef / JabRef/user-documentation

Add detailed tutorial and tutorial into page

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

Similar to https://storybook.js.org/tutorials/intro-to-storybook/.
Into page should outline what the tutorial covers and a table of contents.

The storybook tutorial is also very good, really takes one from nothing to a working solution.

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

Use the linked Storybook tutorial as the reference for the requested structure and level of detail. Define an introductory page with an overview and table of contents, then create a tutorial that takes a reader from no setup to a working solution. Done means both the overview page and the detailed tutorial are available in the user documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.