AOSSIE-Org / AOSSIE-Org/Devr.AI

DOCS UPDATE: Add Core Project Documentation (Contributing, Code of Conduct, Changelog, API, Dev Workflow, Deployment)

Open
#163 3 comments 0 reactions 1 assignee Claimed by @omsherikar View on GitHub
Dominant language
Python
Stars
102
Forks
137
PR merge metrics
No merged PRs in 30d

Description

### Is this related to an existing part of the documentation?

- [x] Yes, it is related to an existing section

### What needs to be updated?

## ✨ Proposed Changes

Fill critical documentation gaps to improve onboarding and collaboration:

- Add CONTRIBUTING.md and CODE_OF_CONDUCT.md
- Create CHANGELOG.md (semantic, unreleased section)
- Add API docs (OpenAPI link and usage examples)
- Write development workflow guide (setup, scripts, tests)
- Complete deployment instructions (Docker, env, services)

## 📋 Additional Context

### Relevant Documentation Link (if any)

_No response_

### Record

- [x] I agree to follow this project's Code of Conduct
- [x] I want to work on this update

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.