Skip to content

docs(readme): comprehensive cleanup after recent shipping wave#274

Merged
outsourc-e merged 1 commit into
mainfrom
docs/readme-comprehensive-polish
May 3, 2026
Merged

docs(readme): comprehensive cleanup after recent shipping wave#274
outsourc-e merged 1 commit into
mainfrom
docs/readme-comprehensive-polish

Conversation

@outsourc-e

Copy link
Copy Markdown
Owner

Eric asked for a proper README review. Found and fixed:

What was stale

What's in this PR

  • Replaced 'Features' bullets with a comprehensive 'What's inside' covering every major surface, with the Conductor upstream-caveat link inline.
  • Restructured Roadmap into Shipped / In progress / Coming, accurate to current state.
  • Removed the 'Agent W' subsection from the public README.
  • Tightened security section headings: '## Security & deployment env vars' with 'Built-in safeguards' + 'Env vars for remote / Docker deployments' as the two subsections.
  • Multi-provider support called out explicitly so a new user immediately knows it works with Anthropic / OpenAI / OpenRouter / Google / Ollama / LM Studio / vLLM / Atomic Chat.

Test plan

  • pnpm build clean
  • Visual diff: README scans cleanly top-to-bottom; sections don't repeat themselves; every claimed feature actually exists.

No code changes.

The README's feature list and roadmap were stale: missing the new MCP
page (#231), Operations dashboard, Agent View panel, Conductor screen,
and capability-gate work landed in the past 24-48h. Roadmap still
listed shipped features as 'In Development'.

Changes:
- Replace short 'Features' bullet list with a comprehensive 'What's
  inside' that mentions every major surface, including the explicit
  Conductor caveat with a link to #262.
- Roadmap restructured into Shipped / In progress / Coming sections.
  Conductor gets its own 'in progress' row with the upstream-plugin
  caveat. Native Desktop App moved to 'in progress' per spec status.
  Multi-provider support called out explicitly so users know what
  works on day one.
- Drop the in-house 'Agent W Managed Companion' subsection from public
  README \u2014 it's internal-team-only deployment notes that don't apply
  to anyone running upstream.
- Collapse the duplicate '## Features' section near the bottom into the
  consolidated security section. Avoids saying the same thing twice.
- Tighten security headings: now '## Security & deployment env vars'
  with two clean subsections: 'Built-in safeguards' and 'Env vars for
  remote / Docker deployments'.

Build clean. No code changes.
@outsourc-e outsourc-e merged commit a4d8388 into main May 3, 2026
3 checks passed
@outsourc-e outsourc-e deleted the docs/readme-comprehensive-polish branch May 3, 2026 17:36
JohnGuidry pushed a commit to JohnGuidry/hermes-workspace that referenced this pull request May 26, 2026
…urc-e#274)

The README's feature list and roadmap were stale: missing the new MCP
page (outsourc-e#231), Operations dashboard, Agent View panel, Conductor screen,
and capability-gate work landed in the past 24-48h. Roadmap still
listed shipped features as 'In Development'.

Changes:
- Replace short 'Features' bullet list with a comprehensive 'What's
  inside' that mentions every major surface, including the explicit
  Conductor caveat with a link to outsourc-e#262.
- Roadmap restructured into Shipped / In progress / Coming sections.
  Conductor gets its own 'in progress' row with the upstream-plugin
  caveat. Native Desktop App moved to 'in progress' per spec status.
  Multi-provider support called out explicitly so users know what
  works on day one.
- Drop the in-house 'Agent W Managed Companion' subsection from public
  README \u2014 it's internal-team-only deployment notes that don't apply
  to anyone running upstream.
- Collapse the duplicate '## Features' section near the bottom into the
  consolidated security section. Avoids saying the same thing twice.
- Tighten security headings: now '## Security & deployment env vars'
  with two clean subsections: 'Built-in safeguards' and 'Env vars for
  remote / Docker deployments'.

Build clean. No code changes.

Co-authored-by: Aurora release bot <release@outsourc-e.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant