Repository navigation
docs: replace the dead AGENTS.md links in CONTRIBUTING - #1014
Merged
Merged
Conversation
CONTRIBUTING.md linked AGENTS.md in four places as the deeper working contract, but AGENTS.md is gitignored, so every one of those links is dead for anyone who clones the repository. Contributors were being pointed at a file they cannot have. Three of the four now point at the public docs that actually cover the material: docs/architecture.md, docs/code-guidelines.md, docs/adding-models.md, and docs/supported-models.md. The fourth carried information with no public home at all. The MLX pin three-file sync table and the post-bump Metal kernel re-validation existed only in the ignored file, so both are inlined here rather than dropped. A contributor bumping the pin can now find the list and the RMS bound without access to a file that is not in the tree.
4 of 8 tasks
5 tasks done
inureyes
added a commit
that referenced
this pull request
Aug 13, 2026
## Summary Three independent one-line documentation staleness fixes from #1106, plus one dangling reference that acceptance criterion 1 turned up outside the three named sites. No code or behavior change. ## What changed **7a. `.github/PULL_REQUEST_TEMPLATE.md`** told first-time contributors to read `AGENTS.md`, which does not exist in a checkout (it is gitignored alongside the other local agent files). PR #1014 replaced the dead links in `CONTRIBUTING.md` but missed the template, which is the surface every contributor sees first. It now points at `CONTRIBUTING.md` and `docs/code-guidelines.md`. **7a follow-on. `tests/surgery_cli.rs`** carried the same dead `AGENTS.md` pointer in the doc comment on `REFERENCE_MODEL`. Acceptance criterion 1 ("no reference to `AGENTS.md` remains outside `CHANGELOG.md`") covers it, so the comment is reworded. Comment text only: no code, no behavior, no test change. The remaining `AGENTS.md` occurrences are the three historical `CHANGELOG.md` entries, which stay, and the `.gitignore` pattern, which is intentional and not a cross-reference. **7b. `docs/supported-models.md` and `docs/turbo-kv-cache.md`** both stamped themselves as describing the `v0.0.27` source tree while the workspace is at `0.5.0-beta.1`. The stamps are dropped rather than bumped, per the issue's reasoning: a stamp nothing verifies goes stale again, and both pages already name the code as the source of truth. This is a stamp change only. The three allowlisted prefixes `turbo-kv-cache.md` lists (`qwen3_5`, `qwen3_5_moe`, `qwen3_next`) still match `ALLOWED_SYMMETRIC_TURBO_FAMILIES` in `src/lib/mlxcel-core/src/cache/turbo/allowlist.rs` exactly, so nothing behind either stamp needed rewriting. The allowlist section gains an explicit pointer to that file as the source of truth in place of the stamp. **7c. `docs/README.md`** enumerated 18 documents while `docs/` holds 19 non-README `.md` files. The missing entry, `code-guidelines.md`, is one of the three core contract documents `CONTRIBUTING.md` names, and the only one of the three that was unindexed. It is added as item 19, described by its two rules: the `// Used by:` shared-function convention and the JIT kernel dtype cache-key requirement. ## Test plan - [x] `python3 scripts/ci/check_cross_repo_refs.py` passes - [x] `cargo fmt --all -- --check` passes - [x] No `AGENTS.md` reference remains outside `CHANGELOG.md` (verified by repo-wide grep; `.gitignore` pattern excluded as intentional) - [x] No `v0.0.27` reference remains under `docs/` (verified by grep) - [x] `ls docs/*.md` and the `docs/README.md` numbered list agree exactly, 19 entries each (verified by sorted diff) Closes #1106
inureyes
added
status:done
be-free-snowboy
pushed a commit
to freestylejs/snowbrain-mlxcel
that referenced
this pull request
Oct 27, 2026
CONTRIBUTING.md linked AGENTS.md in four places as the deeper working contract, but AGENTS.md is gitignored, so every one of those links is dead for anyone who clones the repository. Three now point at the public docs that cover the same material: docs/architecture.md, docs/code-guidelines.md, docs/adding-models.md, and docs/supported-models.md. The fourth carried content with no public home. The MLX pin three-file sync table and the post-bump Metal kernel re-validation existed only in the ignored file, so both are inlined here rather than dropped. A contributor bumping the pin can now find the list and the RMS bound without access to a file that is not in the tree.
be-free-snowboy
pushed a commit
to freestylejs/snowbrain-mlxcel
that referenced
this pull request
Oct 27, 2026
…up#1120) ## Summary Three independent one-line documentation staleness fixes from lablup#1106, plus one dangling reference that acceptance criterion 1 turned up outside the three named sites. No code or behavior change. ## What changed **7a. `.github/PULL_REQUEST_TEMPLATE.md`** told first-time contributors to read `AGENTS.md`, which does not exist in a checkout (it is gitignored alongside the other local agent files). PR lablup#1014 replaced the dead links in `CONTRIBUTING.md` but missed the template, which is the surface every contributor sees first. It now points at `CONTRIBUTING.md` and `docs/code-guidelines.md`. **7a follow-on. `tests/surgery_cli.rs`** carried the same dead `AGENTS.md` pointer in the doc comment on `REFERENCE_MODEL`. Acceptance criterion 1 ("no reference to `AGENTS.md` remains outside `CHANGELOG.md`") covers it, so the comment is reworded. Comment text only: no code, no behavior, no test change. The remaining `AGENTS.md` occurrences are the three historical `CHANGELOG.md` entries, which stay, and the `.gitignore` pattern, which is intentional and not a cross-reference. **7b. `docs/supported-models.md` and `docs/turbo-kv-cache.md`** both stamped themselves as describing the `v0.0.27` source tree while the workspace is at `0.5.0-beta.1`. The stamps are dropped rather than bumped, per the issue's reasoning: a stamp nothing verifies goes stale again, and both pages already name the code as the source of truth. This is a stamp change only. The three allowlisted prefixes `turbo-kv-cache.md` lists (`qwen3_5`, `qwen3_5_moe`, `qwen3_next`) still match `ALLOWED_SYMMETRIC_TURBO_FAMILIES` in `src/lib/mlxcel-core/src/cache/turbo/allowlist.rs` exactly, so nothing behind either stamp needed rewriting. The allowlist section gains an explicit pointer to that file as the source of truth in place of the stamp. **7c. `docs/README.md`** enumerated 18 documents while `docs/` holds 19 non-README `.md` files. The missing entry, `code-guidelines.md`, is one of the three core contract documents `CONTRIBUTING.md` names, and the only one of the three that was unindexed. It is added as item 19, described by its two rules: the `// Used by:` shared-function convention and the JIT kernel dtype cache-key requirement. ## Test plan - [x] `python3 scripts/ci/check_cross_repo_refs.py` passes - [x] `cargo fmt --all -- --check` passes - [x] No `AGENTS.md` reference remains outside `CHANGELOG.md` (verified by repo-wide grep; `.gitignore` pattern excluded as intentional) - [x] No `v0.0.27` reference remains under `docs/` (verified by grep) - [x] `ls docs/*.md` and the `docs/README.md` numbered list agree exactly, 19 entries each (verified by sorted diff) Closes lablup#1106
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.
CONTRIBUTING.md linked
AGENTS.mdin four places as the deeper working contract.AGENTS.mdis gitignored (.gitignore:22), so all four links are dead for anyone who clones the repository.Three now point at the public docs that cover the same material:
docs/architecture.md,docs/code-guidelines.md,docs/adding-models.md,docs/supported-models.md.The fourth pointed at content with no public home. The MLX pin three-file sync table and the mandatory post-bump Metal kernel re-validation lived only in the ignored file, so both are inlined here rather than deleted. A contributor bumping the pin can now find the file list and the RMS < 5e-3 bound without needing a file that is not in the tree.
Verified: no
AGENTSreferences remain in CONTRIBUTING.md, and every path and doc link added here resolves in the tree.