Align edit-base documentation with current runtime and packaging contracts - #910
Draft
OliverZhaohaibin wants to merge 22 commits into
Draft
Align edit-base documentation with current runtime and packaging contracts#910OliverZhaohaibin wants to merge 22 commits into
OliverZhaohaibin wants to merge 22 commits into
Conversation
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
Synchronizes the
edit-basedocumentation with the current runtime, recognition, packaging, and release contracts in one pass.P0 completed
docs/architecture.md:DesktopCoordinatorRuntime, lightweight entrypoint, feature-driven recognition activation, Pets persistence/model/runtime contracts.AGENT.md: adds Pets as a first-class bounded context and documents current startup/coordinator/model rules.docs/misc/PETS_RECOGNITION_RUNTIME.md:species-bounded-single-link-v3, anti-chaining/diameter constraints, current People/Pets overlap arbitration, feature-driven scan activation.docs/development.md: fixesiPhoto.entrypoint:main, coordinator/startup semantics, i18n canonical path, model staging and DINO provisioning.docs/CHANGELOG.md: replaces stale Unreleased startup semantics with the final implementation and clearly separates Unreleased work from v6.6.8.README.md,docs/readme/README_zh-CN.md,docs/readme/README_de.md: aligned release-vs-development semantics and verified v6.6.8 artifact names across all maintained languages.docs/security.md: separates Torch Hub/source provenance from production TorchScript artifact trust; documentstorchscript_url: nulland staging behavior.docs/misc/BUILD_DEB.md: removes 5.00-era instructions and aligns withdist/entrypoint.distandpyproject.tomlversioning.P1 completed
docs/misc/BUILD_APPIMAGE.mdmatchingscripts/build_appimage.sh.docs/misc/BUILD_FLATPAK.md: published v6.6.8 artifact is explicitly distinct from current reproducible source-build support.docs/requirements/scan_c_hotspot_optimization.mdas a current profiling/rebaseline requirement; removed obsolete scanner call graphs/timings.docs/requirements/pets-cluster/README.mdmarking old clustering documents historical/superseded and pointing to the canonical runtime contract.docs/requirements/README.mddefining Active, residual-debt, Historical/Superseded, and Finished lifecycle states. Startup optimization remains in requirements because residual debt is still documented.P2 completed
tools/check_readme_parity.pyto enforce EN/ZH/DE release artifact and core runtime-contract parity.tools/check_docs_links.pyto detect broken repository-local Markdown links.tests/architecture/test_docs_contracts.py; the existing Tests workflow already runs the fulltests/tree on PRs toedit-base, so these checks execute in CI without adding a new workflow permission surface.Source-of-truth contracts
iPhoto.entrypoint:main.DesktopCoordinatorRuntime;main_coordinator.pyis compatibility-only.species-bounded-single-link-v3.torchscript_url: null; package/staging is required for DINOv2.src/extension/models/...is a packaging/staging convention, not guaranteed fresh-clone content.Validation
v6.68-x86-setup.exe.