Skip to content

Extend development documentation - #2653

Merged
AmmarAbouZor merged 6 commits into
esrlabs:masterfrom
AmmarAbouZor:dev-workflows-skills
Sep 29, 2026
Merged

AmmarAbouZor merged 6 commits into
esrlabs:masterfrom
AmmarAbouZor:dev-workflows-skills

Conversation

@AmmarAbouZor

Copy link
Copy Markdown
Contributor

This PR extends the development documentation for this repo. I've added them in .ai directory and linked them in docs/development to make them visible for both developers and AI agents.

It includes:

  • Added .ai/rules/: binding code rules for every change and review, covering all Rust code (rust.md) and the GUI crate on top of it (app-ui.md), with an index and explicit red flags.
  • Added .ai/workflows/release.md: the release process end to end, from release branch and version bumps through tagging, the pre-release test window, release notes, and promotion.
  • Added .ai/knowledge/crates/app/architecture.md: the GUI architecture, covering the frame loop, host/session communication, the service layer, state ownership, extension points, and known runtime traps.
  • Linked .ai/ from the contributing docs as shared context for developers and agents, with the entry point in Getting Started and pointers from the repository structure and development guide.
  • Smaller adjustments: removed the agent-only restrictions on running just and validation commands, documented just validate / just pr as the CI gate, made .ai/knowledge/rust-workspace.md the single source for dependency rules, and listed the utility crates there.

* Add release workflows to .ai directory and wire.
* Release workflow is maid for both developers and agents, and it covers
  each step of the current release workflow
Add general rust development and specific UI rules for agents to be
considered in development and review processes.
+ Wire it up with the existing documentation files.
Those restrictions are personal and shouldn't general rules for this
repo.
`.ai` dir is the main point for structure, rules and tips
@AmmarAbouZor
AmmarAbouZor merged commit 1147bdf into esrlabs:master Sep 29, 2026
1 check passed
@AmmarAbouZor
AmmarAbouZor deleted the dev-workflows-skills branch September 29, 2026 08:29
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