Skip to content

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

@omsherikar

Description

@omsherikar

Is this related to an existing part of the documentation?

  • 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

  • I agree to follow this project's Code of Conduct
  • I want to work on this update

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions