Skip to content

Rewrite README #708

Description

@osvaldoandrade

Update README for new architecture.

Goal: Reflect refactored structure, updated concepts.

Sections:

  • What is codeq?
  • Architecture overview (link to docs/architecture/)
  • Getting started (install, run, examples)
  • Configuration (precedence: flag>env>yaml>default)
  • APIs (HTTP/gRPC/CLI)
  • Development (make targets, testing, coverage)
  • Contributing (link to CONTRIBUTING.md)
  • License

Acceptance criteria:

  • README accurate post-refactor
  • Links to architecture docs
  • Clear onboarding for new contributors

Part of: #655
Requires: Architecture finalized

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationp2

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions