[why.md][documentation] why.md

[nikitakoselev]

Search before asking

• [X] I had searched in the issues and found no similar feature requirement.

Description

The project might benefit from having a "why.md" file, similar to https://github.com/quii/learn-go-with-tests/blob/main/why.md

People don't start contributing because of "how amazing this readme.md" is. We start contributing because the project's story relates to us.

"why.md" is the place to answer that story.

Potential content:

• Why the project was created
• What were the alternatives
• Why we didn't like the alternatives

Use case

I want to be able to open the "why.md" of the project and read a story, which will tell me what we are trying to achieve here.

Related issues

No response

Are you willing to submit a PR?

• [ ] Yes I am willing to submit a PR!

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[mappjzc]

Thank you for your suggestions. @Startrekzky can you help with this issue?

[nikitakoselev]

An example of a story: Helen is a DevOps who likes doing RaspberryPi coding in her free time. Unfortunately she had less and less free time as she spent more and more time doing X manual task. One day she heard about @DevLake. She managed to use DL's product to create solution Y, so now she can finally do more of RaspberryPi.

I understand it is an oversimplified example, but something like this could be nice.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

[Startrekzky]

Thanks @nikitakoselev for your suggestion and nice example. I think it's a good idea to add some use cases or you called the why.md to the README. We're still gathering use cases from the users and if you have one, can you let us know?

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

[github-actions[bot]]

This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.