Skip to content

docs: improve onboarding and usage guide #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Manindra-babu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve onboarding and usage guide #658

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Getting Started & Guide for the project

This guide explains how to install, configure, and use **the project**.

## Quick Start

1. Ensure prerequisites are installed.
2. Follow configuration setup.
3. Run the development environment.

## Best Practices

- Keep configuration separated in environment variables.
- Run test suite prior to submitting changes.
Loading