moja-global / moja-global/FLINT.Reporting

incomplete FLINT prerequisite

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

Nobody has claimed this yet.

Dominant language
Java
Stars
9
Forks
17
PR merge metrics
No merged PRs in 30d

Description

What does the current documentation state?

FLINT Prerequisites

Before we take a leap into the process of development, please take a moment to verify if you have the necessary tools setup and skills to get started on this project. You should be familiar with the following :-

For Windows Based systems

Contents:

.. toctree::
:maxdepth: 2
git

Where is this stated?
prerequisite for FLINT

Why do you want to improve the statement?
This is incomplete as of now. For windows based system, documentation is incomplete and for Linux based system, prerequisite is not there.

Proposed statement
contents should be same as prerequisite of FLINT in moja_global_docs repo

Additional info
None

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

Start with docs/prerequisites/index.rst and compare it with the referenced prerequisites/index.rst in the moja_global_docs repository. Update the FLINT prerequisites so Windows documentation is complete and Linux prerequisites are included, matching the proposed source content. Done means both operating-system sections are present and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.