USACE / USACE/chart-docs

User Documentation: Complete User's Guide Draft

Open
#76 2 comments 0 reactions 1 assignee View on GitHub

@idobbs-2012 is already working on this.

Since May 3, 2024.

documentation
Dominant language
No language data
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The most important remaining task for the first draft is visual aids - what does the input data look like, and more importantly, what does the software look like/what are the important software components at each step in the workflow. The user's guide is the opportunity to get real nuanced into how the software should be used.

I am tracking four incomplete sections:

  1. Flesh out boundary conditions and spatial organization
  2. Flesh out risk identification
  3. Flesh out alternatives
  4. Flesh out study scope task list

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.