Skip to content

Understanding the reason for an instructionΒ #110

@Temidayo32

Description

@Temidayo32

What does the current documentation state?
Screenshot_20211018-081338

Where is this stated?
This is a link to the page where the issue is raised from

Why do you want to improve the statement?
The need to improve the circled section of the page hinges upon a need to better understand why the instruction required of the user of the doc was given. That is, answering the question on, "why the user should make sure to have checked out to the develop Branch for the FLINT Installation?"
What is the reason for this requirement here? What is the implications of not taking the required action?
I strongly believe this is a knowledge gap that needs to be filled in to create better documentation and satisfy users' innate need to understand why they have to take a step.

Proposed statement
The proposed solution, hence, is to state clearly the reason for the action requirement, alongside possible implication of not taking the step.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions