moja-global / moja-global/FLINT.Data_Preprocessing
Refactor Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Issue Description
While browsing through the Documentation folder I found these anomalies.
- I found that Preparing GCBM-FLINT data isn't updated after the V1.0.0 pdf was added in the folder. As the line
If there is no pdf in this folder yet, version 1.0.0 is still being discussed.is pretty much redundant now. - The V1.0.0 pdf has a blank page (pg_no - 13) which maybe was generated by mistake while downloading the Doc as pdf.
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
Start with the linked “Preparing GCBM-FLINT data” document in the Documentation folder and inspect the V1.0.0 PDF, especially page 13. Remove or update the redundant version-status statement and correct the blank PDF page; the documentation and PDF should both reflect the V1.0.0 release without that blank page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100