[DOCS] Add Agents.md, skills and contexts for ai coding assistant#23
Open
VincentG1234 wants to merge 1 commit into
Open
[DOCS] Add Agents.md, skills and contexts for ai coding assistant#23VincentG1234 wants to merge 1 commit into
VincentG1234 wants to merge 1 commit into
Conversation
Signed-off-by: Vincent Gimenes <vincent.gimenes@gmail.com>
179fa6a to
f305792
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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— disablemax_num_partial_prefills(unsupported on V1; comment added).How tested
ruff check .pytest -v tests/Risks / limitations
.ai/context/current-work.mdis a point-in-time snapshot (open PRs [FIX] local backend trial cleanup #13, [FIX] add guidellm preflight check and pin vllm to <=0.19 #17, [FIX] Do not charge baseline trials against the optimizationn_trialsbudget (+ test) #21, [FEAT] add log_metrics as Optuna trial user attrs #22); it will drift until refreshed after merges.Links