From d1bad211e96ed18502312b91572a1bb03b50676c Mon Sep 17 00:00:00 2001 From: Chaoming Wang Date: Tue, 20 Oct 2026 15:25:28 +0800 Subject: [PATCH] docs: move specs from doc/specs to docs/specs --- AGENTS.md | 2 +- {doc => docs}/specs/2026-10-audit-fixes.md | 2 +- {doc => docs}/specs/ci-optional-framework-jax-compat.md | 0 {doc => docs}/specs/jax-0.12-compat.md | 0 {doc => docs}/specs/respect-jax-x64-on-import.md | 0 5 files changed, 2 insertions(+), 2 deletions(-) rename {doc => docs}/specs/2026-10-audit-fixes.md (99%) rename {doc => docs}/specs/ci-optional-framework-jax-compat.md (100%) rename {doc => docs}/specs/jax-0.12-compat.md (100%) rename {doc => docs}/specs/respect-jax-x64-on-import.md (100%) diff --git a/AGENTS.md b/AGENTS.md index 601e90b..96c2940 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -9,7 +9,7 @@ 5. Every correction: reflect on the mistake, plan to avoid repeating it. 6. All updates must be happened on the worktree branch, not main. 7. Use `brainstate.random` instead of `jax.random` directly for all random number generation. -8. Write spec and plan under `doc/specs` before implementation, so they're available for reference during implementation. +8. Write spec and plan under `docs/specs` before implementation, so they're available for reference during implementation. 9. Tests should >90% coverage, but focus on meaningful tests that cover edge cases and critical paths, not just trivial lines. 10. Maintain compatibility with JAX versions >= 0.9.0. Guard any version-specific behavior in `brainstate/_compatible_import.py`, preferring feature/shape detection over hard version checks. diff --git a/doc/specs/2026-10-audit-fixes.md b/docs/specs/2026-10-audit-fixes.md similarity index 99% rename from doc/specs/2026-10-audit-fixes.md rename to docs/specs/2026-10-audit-fixes.md index dbb964d..6b3d20e 100644 --- a/doc/specs/2026-10-audit-fixes.md +++ b/docs/specs/2026-10-audit-fixes.md @@ -10,7 +10,7 @@ Decisions already made: Workflow, per AGENTS.md: 1. Create the worktree branch `fix/audit-high-medium`. Nothing is committed to main. -2. Write a spec at `doc/specs/2026-10-audit-fixes.md`, a copy of this plan with the bug table. +2. Write a spec at `docs/specs/2026-10-audit-fixes.md`, a copy of this plan with the bug table. 3. For each bug, first write a failing regression test in the matching `*_test.py`, then make the fix. 4. Use `brainstate.random` in tests, never `jax.random`. 5. Version-specific code goes in `_compatible_import.py`, using feature detection. diff --git a/doc/specs/ci-optional-framework-jax-compat.md b/docs/specs/ci-optional-framework-jax-compat.md similarity index 100% rename from doc/specs/ci-optional-framework-jax-compat.md rename to docs/specs/ci-optional-framework-jax-compat.md diff --git a/doc/specs/jax-0.12-compat.md b/docs/specs/jax-0.12-compat.md similarity index 100% rename from doc/specs/jax-0.12-compat.md rename to docs/specs/jax-0.12-compat.md diff --git a/doc/specs/respect-jax-x64-on-import.md b/docs/specs/respect-jax-x64-on-import.md similarity index 100% rename from doc/specs/respect-jax-x64-on-import.md rename to docs/specs/respect-jax-x64-on-import.md