isce-framework / isce-framework/dolphin
[New Feature]: How about making an FAQ section in the documentation of Dolphin?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 153
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Checked for duplicates
Yes - I've already checked
Alternatives considered
Yes - and alternatives don't suffice
Related problems
No response
Describe the feature request
I have asked some questions about issues I faced to run the Dolphin( #501 #503 #504 #506 #511). Now, I am able to use ISCE2 stack output as an input to the Dolphin software to get a displacement velocity output.
@scottstanie kindly answered all the questions I made, so I really appreciate his kind help and effort. My idea is to make an FAQ section on the Dolphin's webpage so that users may refer to it first when they have similar questions (not only mine, but also other typical tips listed in past issues & discussions).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the questions and answers referenced in issues #501, #503, #504, #506, and #511, then inspect Dolphin's current webpage documentation. Define the FAQ scope and entries from those discussions; done means the recurring user questions and their answers are organized in a published FAQ section.
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
- Needs clarification
- Newbie friendliness
- 25/100