Skip to content

docs: rewrite README for current features, update CONTRIBUTING and CLAUDE.md#866

Merged
EhabY merged 2 commits intomainfrom
docs/update-readme-and-guidelines
Mar 30, 2026
Merged

docs: rewrite README for current features, update CONTRIBUTING and CLAUDE.md#866
EhabY merged 2 commits intomainfrom
docs/update-readme-and-guidelines

Conversation

@EhabY
Copy link
Copy Markdown
Collaborator

@EhabY EhabY commented Mar 27, 2026

  • Rename CLAUDE.md to AGENTS.md, the cross-tool standard recognized by Claude Code, Gemini CLI, Codex, and other AI coding agents.
  • Restructure agent guidelines with clearer sections (relationship, foundational rules, commands table) and add rules for as unknown as and unnecessary changes, inspired by coder/coder's AGENTS.md.
  • Rewrite README feature list to reflect current capabilities: Tasks, Chat, multi-deployment, dev containers, SSH tuning, OAuth 2.1, and keyring support.
  • Update CONTRIBUTING with current sidebar panels (Tasks, Chat).

@EhabY EhabY force-pushed the docs/update-readme-and-guidelines branch from e495996 to 00b6ad6 Compare March 27, 2026 15:12
@EhabY EhabY self-assigned this Mar 27, 2026
@EhabY EhabY force-pushed the docs/update-readme-and-guidelines branch 3 times, most recently from 6710454 to 6d0183e Compare March 27, 2026 16:36
Rename CLAUDE.md to AGENTS.md (the cross-tool standard for AI coding
agents). Restructure guidelines with clearer sections for relationship,
foundational rules, and commands table. Add rules for `as unknown as`
and unnecessary changes.

Update README with current feature list, update CONTRIBUTING with
current sidebar panels, and bump dev dependencies.
@EhabY EhabY force-pushed the docs/update-readme-and-guidelines branch from 6d0183e to f2a3f64 Compare March 30, 2026 09:43
Copy link
Copy Markdown
Member

@mtojek mtojek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would extract dependency updates to a separate PR, but it isn't blocking 👍

@EhabY
Copy link
Copy Markdown
Collaborator Author

EhabY commented Mar 30, 2026

@mtojek separated the deps update to #868 👀

@EhabY EhabY merged commit c95a6f7 into main Mar 30, 2026
6 checks passed
@EhabY EhabY deleted the docs/update-readme-and-guidelines branch March 30, 2026 10:47
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.

2 participants