Skip to content

[DOCS] Add Agents.md, skills and contexts for ai coding assistant#23

Open
VincentG1234 wants to merge 1 commit into
mainfrom
add-ai-folder
Open

[DOCS] Add Agents.md, skills and contexts for ai coding assistant#23
VincentG1234 wants to merge 1 commit into
mainfrom
add-ai-folder

Conversation

@VincentG1234
Copy link
Copy Markdown
Collaborator

@VincentG1234 VincentG1234 commented May 19, 2026

Summary

Add structured documentation for human maintainers and coding agents: AGENTS.md, .ai/context/, .ai/skills/, and a user-facing architecture guide with Mermaid diagrams. Link the new doc from README and quick start. Align the local example YAML with vLLM V1 constraints.

Why

The InseeFrLab fork needs a stable onboarding path for contributors and agents (local backend focus, safe commands, known issues/PRs) without reading the whole codebase. Architecture was previously only implicit in code; diagrams improve onboarding and reviews.

What changed

  • AGENTS.md — entry point for agents (context files, skills, safe commands).
  • .ai/context/ — repo map, execution flow, history, known issues, current work snapshot, external links.
  • .ai/skills/ — pr-writer, pr-reviewer, test-writer, docs-writer, architecture-diagrams.
  • docs/architecture.md — end-to-end, layout, orchestration, trial lifecycle, outputs (Mermaid).
  • README.md, docs/quick_start.md — links to architecture doc.
  • examples/study_config_local_exec.yaml — disable max_num_partial_prefills (unsupported on V1; comment added).

How tested

  • ruff check .
  • pytest -v tests/
  • Manual E2E (maintainer): not required (docs-only PR)

Risks / limitations

Links

  • (none — no issue closed)

Signed-off-by: Vincent Gimenes <vincent.gimenes@gmail.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