added the essential docs

[omsherikar]

Closes #163

📝 Description

Added the essential documentation including:

• Code of Conduct.md
• Contributing.md
• Changelog.md
• Developement.md
• Deployment.md
• API.md

✅ Checklist

• I have read the contributing guidelines.
• I have added tests that prove my fix is effective or that my feature works.
• I have added necessary documentation (if applicable).
• Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

Documentation

• Added API documentation covering endpoints, authentication, and usage examples
• Added development workflow guide with setup, testing, and code quality instructions
• Added deployment guide for local and production environment configuration
• Added contribution guidelines detailing code style standards and PR requirements
• Added Code of Conduct establishing community standards and enforcement policies
• Added changelog documenting project changes and releases

[coderabbitai]

Walkthrough

This pull request adds six new documentation files to the project: CODE_OF_CONDUCT.md, CONTRIBUTING.md, CHANGELOG.md, API.md, DEPLOYMENT.md, and DEVELOPMENT.md. The files cover community standards, contribution guidelines, project changelog, API usage, deployment instructions, and development workflow setup, with no functional code modifications.

Changes

Cohort / File(s)	Summary
New Documentation Files CODE_OF_CONDUCT.md, CONTRIBUTING.md, CHANGELOG.md, API.md, DEPLOYMENT.md, DEVELOPMENT.md	Adds comprehensive project documentation covering community standards and behavior expectations, contribution guidelines with setup and testing instructions, changelog documenting initial releases and setup fixes, API endpoints and usage examples, deployment procedures including Docker and environment configuration, and development workflow with prerequisites, setup scripts, and quality checks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

• All changes are static documentation files with no code logic
• Verification needed for accuracy of commands, URLs, and procedural steps referenced
• Confirm alignment with actual project setup and deployment processes

Suggested reviewers

• smokeyScraper

Poem

🐰 In bustling warrens of code we hop and bound,
Now docs light our path, so clear and profound!
From conduct to guides, deployment and more,
The roadmap unfolds—what's community for! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "added the essential docs" is concise and clearly communicates that documentation is being added. While the term "essential" is somewhat generic, it is not so vague as to be meaningless like "misc updates" or "stuff". A teammate scanning the commit history would understand that this PR adds documentation files. The title is reasonably descriptive in context and directly relates to the main purpose of the changeset, which is to introduce multiple documentation files.
Linked Issues Check	✅ Passed	The PR successfully addresses all coding-related requirements from issue #163. The changeset includes CONTRIBUTING.md and CODE_OF_CONDUCT.md for community guidelines, CHANGELOG.md with an "Unreleased" section for semantic versioning, API.md with OpenAPI documentation and usage examples, DEVELOPMENT.md documenting setup and workflow commands, and DEPLOYMENT.md covering Docker configuration and deployment instructions. Each file is present and contains the relevant documentation as specified in the linked issue requirements.
Out of Scope Changes Check	✅ Passed	All six files introduced in this PR (API.md, CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, DEPLOYMENT.md, and DEVELOPMENT.md) are directly aligned with the specific documentation requirements stated in issue #163. The summaries confirm these are purely documentation files with no functional code changes, and each file directly fulfills one of the five stated objectives. There are no apparent out-of-scope changes or unrelated modifications introduced in this changeset.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (5)

CHANGELOG.md (1)

5-7: Consider adopting a more structured changelog format.

The changelog currently lists items as bullets under "Unreleased." Consider categorizing changes using standard sections (Added, Changed, Fixed, Deprecated, Removed, Security) per the Keep a Changelog convention for better clarity as the project grows. This makes it easier for users to scan what changed between versions.

Example structure:

## [Unreleased]

### Added
- Initial docs: contributing, code of conduct, changelog, API, dev workflow, deployment.
- Setup fixes: root `start.py`, Poetry entry point.

This becomes more valuable as you accumulate changes across multiple versions.

DEVELOPMENT.md (1)

32-38: Clarify which quality tools apply to frontend vs. backend.

The Quality section lists both Python tools (black, isort, flake8, mypy) and TS/JS tools (eslint, prettier, npm run type-check) in a single code block, which may cause confusion. Consider splitting into separate subsections or explicitly calling out which tools apply to each stack.

Example:

## Quality

### Backend
black . && isort . && flake8 && mypy

### Frontend
cd frontend && npm run format && npm run lint && npm run type-check

This makes it clearer which commands to run depending on what you're working on.

CODE_OF_CONDUCT.md (1)

13-15: Add specific contact information for reporting code of conduct violations.

Line 14 states "Report issues privately via maintainers or security advisories" but doesn't specify HOW to contact maintainers. Add a specific email address, Discord server, GitHub security advisory link, or issue template for reporting violations.

Example enhancement:

## Enforcement
- Report issues privately to: [[email protected]](mailto:[email protected]) or via GitHub Security Advisory.
- Maintainers may take action: warnings, temporary/permanent bans.
- Decisions are final to protect community safety.

This removes ambiguity and makes it easier for community members to report issues.

Confirm where maintainers' contact information is published (README, MAINTAINERS.md file, or elsewhere in the repo) so we can reference it here or ensure consistency.

CONTRIBUTING.md (2)

4-8: Approve Quick Start section; minor clarity suggestion on code style tools.

The Quick Start is clear and provides a good flow for new contributors. However, in line 8, the code style tools listed include both Python (black, isort, flake8) and TS/JS tools (eslint, prettier) without clarification of which apply where. Consider reorganizing similar to the suggestion in DEVELOPMENT.md to avoid confusion.

---

21-22: Specify the email address for security vulnerability reporting.

Line 22 states "Report vulnerabilities privately via security advisory or email" but doesn't specify which email address. This should match or cross-reference the contact information provided in CODE_OF_CONDUCT.md (line 14). Ensure consistency across both documents.

Example:

## Security
- Report vulnerabilities privately to: [[email protected]](mailto:[email protected]) or via GitHub Security Advisory.

Confirm what the actual contact point is so we can update both CODE_OF_CONDUCT.md and CONTRIBUTING.md consistently.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8eeacad and baeeb66.

⛔ Files ignored due to path filters (3)

• .DS_Store is excluded by !**/.DS_Store
• .github/.DS_Store is excluded by !**/.DS_Store
• backend/.DS_Store is excluded by !**/.DS_Store

📒 Files selected for processing (6)

• API.md (1 hunks)
• CHANGELOG.md (1 hunks)
• CODE_OF_CONDUCT.md (1 hunks)
• CONTRIBUTING.md (1 hunks)
• DEPLOYMENT.md (1 hunks)
• DEVELOPMENT.md (1 hunks)

🔇 Additional comments (2)

API.md (1)

1-29: API documentation is clear and well-structured.

The documentation effectively covers the essential endpoints, provides practical curl examples, and clearly references configuration requirements and development setup guides. The reference to DEVELOPMENT.md for local setup is helpful.

One note: verify that the endpoints documented (particularly /api/v1/auth/login and /health) match the actual implementation in your codebase. If the API has evolved, this documentation may need updating.

DEPLOYMENT.md (1)

3-6: No action needed—env.example file is present and correctly configured.

The verification confirms that env.example exists in the repository with proper placeholder values for SUPABASE_URL, SUPABASE_KEY, and multiple integration keys as documented in DEPLOYMENT.md. The deployment instructions are accurate and ready for use.