Skip to content

Add AGENTS.md documentation structure#151

Open
napetrov wants to merge 3 commits intomasterfrom
add-agents-docs
Open

Add AGENTS.md documentation structure#151
napetrov wants to merge 3 commits intomasterfrom
add-agents-docs

Conversation

@napetrov
Copy link

Add hierarchical AGENTS.md files for agent context throughout the repository:

  • Root AGENTS.md: ecosystem overview, key components, build deps, distribution
  • .github/AGENTS.md: CI/CD workflows, multi-platform support (Linux/Windows/macOS)
  • mkl/AGENTS.md: Python/Cython implementation details, MKL support function categories
  • mkl/tests/AGENTS.md: unit test coverage and running instructions
  • conda-recipe/AGENTS.md: conda packaging for multiple platforms
  • examples/AGENTS.md: usage examples for runtime control API

Follows the established dpnp/mkl_umath pattern for consistency across IntelPython ecosystem.

What changed: 6 new AGENTS.md files (258 lines)
No code changes: documentation only
Pattern: entry point with directory map + focused subdirectory context

- Root AGENTS.md with ecosystem context and directory map
- .github/AGENTS.md: CI/CD workflows, multi-platform support
- mkl/AGENTS.md: Python/Cython implementation, MKL support functions
- mkl/tests/AGENTS.md: unit tests and validation
- conda-recipe/AGENTS.md: conda packaging for multiple platforms
- examples/AGENTS.md: usage examples

Follows dpnp/mkl_umath AGENTS.md pattern for IntelPython ecosystem consistency.
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a hierarchical AGENTS.md documentation structure intended to provide “agent context” at the repo root and within key subdirectories (CI, core implementation, tests, packaging, examples).

Changes:

  • Added root AGENTS.md as the entry point with repo overview + directory map to sub-AGENTS files
  • Added subdirectory AGENTS.md files under .github/, mkl/, mkl/tests/, conda-recipe/, and examples/
  • Documented intended CI/CD, packaging, API categories, and test/example guidance

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
AGENTS.md Root entry point describing repo purpose, build/deps, CI, and links to subdirectory AGENTS docs
.github/AGENTS.md Documents CI workflows and policies for GitHub Actions
mkl/AGENTS.md Documents module structure, API categories, and native-extension components
mkl/tests/AGENTS.md Documents unit tests, intended coverage areas, and how to run tests
conda-recipe/AGENTS.md Documents conda recipe inputs, build configuration, and CI usage
examples/AGENTS.md Documents example scripts and what they demonstrate

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@napetrov
Copy link
Author

napetrov commented Mar 3, 2026

Addressed Copilot review comments in 762caad:\n\n- corrected CI platform descriptions (Linux/Windows only in current workflows)\n- fixed conda-recipe notes for (compiler/stdlb pinning, not Python matrix)\n- updated compiler wording to pinned toolchains\n- aligned with actual content\n- narrowed test edge-case claims to current coverage\n- fixed platform note for vs \n- added to mirror the mkl_fft/mkl_random pattern\n\nPlease re-run review.

@napetrov
Copy link
Author

napetrov commented Mar 3, 2026

Correction: formatting in previous comment was mangled by shell quoting.\n\nAddressed Copilot review comments in 762caad:\n- corrected CI platform descriptions (Linux/Windows only in current workflows)\n- fixed conda-recipe notes for conda_build_config.yaml (compiler/stdlib pinning, not Python matrix)\n- updated compiler wording to pinned toolchains\n- aligned examples/AGENTS.md with actual examples/example.py content\n- narrowed test edge-case claims to current coverage\n- fixed platform note for mkl/_mklinitmodule.c vs mkl/_init_helper.py\n- added .github/copilot-instructions.md to mirror mkl_fft/mkl_random pattern\n\nPlease re-run review.

@antonwolfy antonwolfy added this to the 2.7.0 release milestone Mar 5, 2026
Copy link
Collaborator

@antonwolfy antonwolfy left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

3 participants