hpc / hpc/mpifileutils

dtools: new utility for user docs

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

Nobody has claimed this yet.

Dominant language
C
Stars
200
Forks
85
Avg merge
3d 21h
Merged PRs (30d)
2

Description

Maybe we should make a dtools utility which can help users interact with all the tools we have. This could include the ability to print help / manpages of the tools, plus a simple user tutorial.

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

No files, tests, or entry points are named. Start by reviewing the existing tools and how they expose help or manpages, then determine the scope of a unified dtools utility and its user tutorial. Done should include an agreed interface covering the existing tools and corresponding documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.