diff --git a/AGENTS.md b/AGENTS.md index 003de29..ef9a42d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -42,6 +42,8 @@ pre-commit install pre-commit run --all-files ``` +Staged `*.py` files trigger `hatch run lint` (includes pylint) via `scripts/pre-commit-quality-checks.sh`, matching `.github/workflows/pr-orchestrator.yml`. + ## Development workflow ### Branch protection diff --git a/CHANGELOG.md b/CHANGELOG.md index 177052a..2ba436a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this repository will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project follows SemVer for bundle versions. +## [Unreleased] + +### Added + +- Documentation: authoritative `docs/reference/documentation-url-contract.md` for core vs modules URL ownership; `redirect_from` aliases for legacy `/guides//` on pages whose canonical path is outside `/guides/`; sidebar link to the contract page. + ## [0.44.0] - 2026-03-17 ### Added diff --git a/README.md b/README.md index 9e0ae5f..ad563fc 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ This repository hosts official nold-ai bundles only. - Official bundles are maintained under `packages/`. - Third-party bundles are published from third-party repositories and are not hosted here. - Bundle and module documentation changes are made in this repository under `docs/`. +- Cross-site linking rules and canonical paths for core→modules handoffs: `docs/reference/documentation-url-contract.md` (published: `https://modules.specfact.io/reference/documentation-url-contract/`). - GitHub Pages documentation target: `https://nold-ai.github.io/specfact-cli-modules/`. ## Local development (IDE / Cursor) @@ -53,6 +54,7 @@ pre-commit run --all-files ``` Scope notes: +- Pre-commit runs `hatch run lint` when any staged file is `*.py`, matching the CI quality job (Ruff alone does not run pylint). - `ruff` runs on the full repo. - `basedpyright` and `pylint` are scoped to `src/`, `tests/`, and `tools/` for modules-repo infrastructure parity. - Bundle-package behavioral validation is covered through `test`, `contract-test`, and migration-specific suite additions under `tests/`. diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 0b2d36c..172dbc0 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -222,6 +222,7 @@

Reference