llnl / llnl/SAMRAI

SAMRAI user docs?

Open
#203 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
250
Forks
89
Avg merge
34m
Merged PRs (30d)
1

Description

Are SAMRAI user docs maintained someplace? I see that there are some files in the docs directory, but there is no mention of that and no links to any other documentation on the GitHub project page. It would be good to point users at docs you do have.

Also, the link to SAMRAI publications on the GitHub project page is broken.

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 the repository's docs directory and the links on the GitHub project page, including the SAMRAI publications link. Determine which user documentation is maintained and verify the correct publications destination. Done means the project page points users to available documentation and the broken publications link is corrected.

Written by the indexing model from the issue text.

Assessment

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.