Skip to content

First tagged release, expanded docs, and reference deployment #11

Description

@haasonsaas

Problem

The repository currently has no releases (0 published), 11 commits, and documentation limited to a few docs/ files. For teams to adopt Room as a security control, they need versioned releases, comprehensive docs, and a known-good reference deployment.

Proposal

Releases

  • Tag a v0.1.0 release once the test suite is green with -race
  • Publish pre-built binaries (or a container image) via GitHub Releases
  • Maintain a changelog

Documentation

  • Quickstart guide (zero-to-enforcement in under 15 minutes)
  • Deployment guide (self-hosted, container, systemd)
  • Architecture overview aimed at security reviewers (the external-analyzer boundary is the key design decision and should be explained thoroughly)
  • Analyzer development guide with a worked example
  • Threat model document

Reference deployment

  • A docker-compose or similar setup that runs roomd, room-mcp, and a sample analyzer end-to-end
  • An example GitHub Actions workflow showing CI integration

Why

Security tooling requires trust, which comes from versioned releases, clear documentation, and reproducible deployments. The current state is sufficient for experimentation but not for production adoption.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions