llnl / llnl/hatchet

Update basic tutorial on RTD

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-docs priority-normal type-feature
Dominant language
JavaScript
Stars
37
Forks
21
PR merge metrics
No merged PRs in 30d

Description

Update basic tutorial to walk through hatchet-tutorial github: https://llnl-hatchet.readthedocs.io/en/latest/basic_tutorial.html#installing-hatchet-and-tutorial-setup

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

Open the linked Read the Docs basic tutorial and inspect how it currently covers installation and tutorial setup. Compare that walkthrough with the hatchet-tutorial GitHub repository referenced in the issue. Done means the basic tutorial accurately walks readers through the repository and its setup steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.