Skip to content

docs: refresh AGENTS.md + README for v0.13.0 accuracy#48

Merged
offendingcommit merged 1 commit into
mainfrom
docs/refresh-agents-readme
May 29, 2026
Merged

docs: refresh AGENTS.md + README for v0.13.0 accuracy#48
offendingcommit merged 1 commit into
mainfrom
docs/refresh-agents-readme

Conversation

@offendingcommit
Copy link
Copy Markdown
Owner

Accuracy pass on AGENTS.md and README.md — both predated this release's features.

Factual fixes (verified against the repo):

  • localStorage key: openconcho:configopenconcho:instances (multi-instance store; legacy key auto-migrated) — fixed in both files.
  • README prerequisites: Node ≥ 22 (was ≥ 20), pnpm 10 (was ≥ 9) — matches engines/packageManager.
  • README downloads: added Linux .rpm (shipped in v0.13.0).

Additions:

  • AGENTS.md: note the local husky pre-commit (secret scan + Biome) / pre-push (pnpm check) gates.
  • README Features: fleet dashboard, seed kits, multiple instances, dream viewer, dialectic playground, peer display names, demo mode.
  • README: a Docker/Compose quick-start (GHCR image + docker-compose.yml + docs/docker.md).

Docs only — type docs → no version bump.

- Correct localStorage key (openconcho:instances, not :config) in both
- AGENTS.md: note local husky pre-commit/pre-push gates
- README: fix prerequisites (Node >=22, pnpm 10)
- README: add shipped features (fleet, seed kits, multi-instance, dream
  viewer, dialectic playground, peer display names, demo mode)
- README: add .rpm to downloads + a Docker/Compose quick-start section
@offendingcommit offendingcommit merged commit 8f8a64c into main May 29, 2026
2 checks passed
@offendingcommit offendingcommit deleted the docs/refresh-agents-readme branch May 29, 2026 16:38
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