moja-global / moja-global/Handbook

Queries Regarding the Handbook

Open
#25 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5
Forks
13
PR merge metrics
No merged PRs in 30d

Description

NOT FOR CONTRIBUTING YET

These are some of the queries that I had regarding the Handbook, filing this as an issue to keep track of and to discuss it.

  1. In Chapter 3/section_one (End-to-end workflow for the GCBM Analysis)

Why do these 2 points are left unexplained, is this how it was meant to be OR will there be more content pushed in the future OR we can remove them?

Also, in the Stimulation a figure of workflow is absent.

Screenshot from 2023-02-06 01-23-51

  1. In Chapter 3/section_two (post-processing)
    Here we are discussing about the post-processing of GCBM stimulation, but we haven't talked about running the stimulation until Ch-5, so wouldn't it be better to include post-processing in Ch-5?

  2. Also in the same chapter3/section_two in What is the difference between NEP and NBP?
    We haven't defined what is NEP.

  3. In Chapter 2/section_one

    Screenshot from 2023-02-06 00-41-54

I think we are missing "max " here in this equation.
for reference : https://github.com/moja-global/FLINT.Module.Chapman_Richards

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.

Research direction

Read Chapter 3/section_one and section_two, then Chapter 2/section_one, following the linked Handbook pages and the FLINT.Module.Chapman_Richards reference. First resolve whether the missing explanations, workflow figure, chapter placement, NEP definition, and equation correction are intended changes or discussion points. Done would require agreed documentation edits, but the issue currently says it is not ready for contribution.

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
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.