Skip to content

docs: add quick start, dev setup & troubleshooting (Fixes #1407)#1436

Open
kkrishnan10 wants to merge 1 commit intoresponsively-org:mainfrom
kkrishnan10:issue-1407-docs-missing
Open

docs: add quick start, dev setup & troubleshooting (Fixes #1407)#1436
kkrishnan10 wants to merge 1 commit intoresponsively-org:mainfrom
kkrishnan10:issue-1407-docs-missing

Conversation

@kkrishnan10
Copy link
Copy Markdown

Fixes #1407
This pull request updates the documentation to make it easier for new users and first-time contributors.
I added:

  • a Quick Start section with install and first-run steps
  • a short Dev Setup (TL;DR) for building locally
  • a Troubleshooting section for common setup issues
  • and a First Contribution Checklist to guide new contributors
    These updates are documentation-only (README.md and docs/build-and-run.md).
    No code changes or build impact.
    I checked that the Markdown formatting looks good and that all the links work correctly in GitHub’s preview. Since this is just a docs update, no functional testing was needed.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


karthikakris seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add missing documentation

2 participants