[docs] : Improve installation guide for local development

[aialok]

Description:

I noticed that some people are facing issues while setting up the project locally. Some parts of the documentation are not very clear.

For example, it's hard to understand which environment variables are required and which ones are optional for contribution. Also, after updating the environment file, we need to run the env script to sync everything properly.

Things we can improve

• Most of the time, people make the mistake of cloning the repo directly without forking it. There are no instructions telling them to fork the repo first.

• There are two methods to install the project: standard and devcontainer. But both are almost the same. This is redundant and can be simplified.

• The environment variable setup is unclear. It should be done first before anything else.

• These two commands are a bit unclear. A proper explanation should be provided, as most people make the mistake of setting up the .env file but forget to run the sync command.

pnpm nizzy env to set up environment variables pnpm nizzy sync to sync environment variables and types

• There are many environment variables that are optional. We should have clear documentation showing which ones are required and which are optional.

• We can create a separate INSTALLATION.md file for the complete installation process.

• The instructions should be well-organized and follow a proper order. Each step should be clearly explained.

This will help developers get started with the project easily and without any hassle.

Current setup instruction : https://github.com/Mail-0/Zero/blob/staging/README.md

[linear[bot]]

ZERO-235 [docs] : Improve installation guide for local development

[aialok]

Hi @Malayt04 , thanks for your contribution.

I just wanted to let you know that I was already assigned to this issue and had started working on it. In open source, it is usually a good idea to not work on issues that are already assigned to someone. It helps avoid doing the same work twice.

I understand this might have been unintentional, and I appreciate your effort. Just wanted to mention it for future contributions so we can all avoid overlapping work.

Thank you : )

[Malayt04]

@aialok that was totally unintentional. I was about to create an issue regarding the docs, but then I saw you had already raised it. I didn’t realize it was assigned to you—sorry about that, my bad!

[github-actions[bot]]

This issue is stale (3+ days) and will be closed.

[github-actions[bot]]

Closing stale issue.