Docs need more instructions on what each step does

[tapishr]

Setup Guide Design

Introduction page

Our documentation will have an introduction page which will go in depth about the features, the architecture and the steps to set it up.

User Guide

Getting Started

For the quick setup guide, we will have a single page with clear instructions on the next step based on the previous step. We will not have separate pages for each step of the setup because it lacks sequence and would turn out to be confusing.

Installation for GitHub

We will have several pages for each part of this so that people can access the guides for each page even if they are not doing the installation themselves. These pages will be non-actionable. Only explanatory.

Installation for Bitbucket

Same as the GitHub section - only explanations so that a person can understand how things work in a different device than the one they are using for the actual installation.

Developer Guide

This section will be dedicated to getting a new contributor started with Vibinex.

Setting up the environment

• What are the things they need to install
• How do they acquire the various environment variables needed
• Running the whole application end-to-end

Understanding the code

• Definitions (provider, owner, repository, pull request, review, hunk, author, relevant reviewer)
• Folder structure of each repository
• Network architecture & PubSub

Contribution Guide

• Communication (tags in issues, joining Slack, basic etiquette)
• Branching, formatting, testing (sanity check, unit testing, end-to-end testing)
• Perks (compensation through alokit.in, opportunity to work with the Vibinex team, entry into the OSS ecosystem),

[tapishr]

Note should be lighter, in italics, change on configuration selection, bulleted or numbered, can include link to architecture/data diagram