AllenInstitute / AllenInstitute/MIES

Start end user documentation (screencasts, manual)

Open
#29 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
IGOR Pro
Stars
30
Forks
11
Avg merge
1d 40m
Merged PRs (30d)
8

Description

  • sphinx based getting started manual
  • introductory screencast videos

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

The issue identifies two deliverables: a Sphinx-based getting-started manual and introductory screencast videos. Start by determining the intended manual scope and video topics; the work is done when both the manual and screencasts provide an introductory path for end users.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.