1.0: Update API references and examples for AsiBackbone 6.0 - #344
Merged
Merged
Conversation
cdcavell
added a commit
that referenced
this pull request
Sep 19, 2026
* docs: align Learning terminology with AsiBackbone 6.0 (#343) Closes #339 ## Summary - align Learning terminology and branding with AsiBackbone 6.0 across documentation, navigation, diagrams, templates, and samples - replace obsolete audit-residue language with decision receipts while keeping acknowledgment, capability grants, and host-owned execution as distinct lifecycle concepts - rename the foundational tutorial, lab, and sample and update implementation links to the release/6.0.0 API surface - run documentation and sample validation for pull requests targeting release/1.0.0 ## Validation - `dotnet restore Samples.slnx --locked-mode` - `dotnet build Samples.slnx --no-restore` - `dotnet format Samples.slnx --verify-no-changes --no-restore --verbosity minimal` - `dotnet test Samples.slnx --no-build` (300 passed) - `dotnet tool run docfx docs/docfx.json --warningsAsErrors` - DocFX template baseline, metadata, sitemap, IndexNow, feed, and X publisher self-tests - Lychee link validation (2,784 OK, 0 errors, 3 configured exclusions) * docs: validate AsiBackbone 6.0 API references (#344) Closes #340 ## Summary - add a canonical AsiBackbone 6.0 API boundary guide with finalized core names, namespaces, evaluator construction, endpoint markers, and all seven removed compatibility members - clearly distinguish Learning-owned framework-neutral teaching models from exact package API examples, including ambiguous receipt and acknowledgment snippets - document that current executable samples intentionally have no AsiBackbone package references; future package-integration samples must pin and lock a released 6.x version - add a CI validator covering all 102 upstream type renames, removed API names, implementation links outside release/6.0.0, code-scope notices, and future AsiBackbone package versions ## Upstream baseline reviewed - AsiBackbone/AsiBackbone#785 — obsolete API removals - AsiBackbone/AsiBackbone#786 — complete public API naming inventory - AsiBackbone/AsiBackbone#787 — finalized terminology - release/6.0.0 migration guide and source tree ## Validation - `dotnet restore Samples.slnx --locked-mode` - `dotnet build Samples.slnx --no-restore` (0 warnings, 0 errors) - `dotnet format Samples.slnx --verify-no-changes --no-restore --verbosity minimal` - `dotnet test Samples.slnx --no-build` (300 passed) - AsiBackbone 6.0 API-reference validator (348 instructional files) - `dotnet tool run docfx docs/docfx.json --warningsAsErrors` (0 warnings, 0 errors) - DocFX template baseline, metadata, sitemap, IndexNow, feed, and X publisher validation - Lychee link validation (2,801 OK, 0 errors, 3 configured exclusions) * docs: add Learning 1.0 compatibility guide for AsiBackbone 6.0 (#345) ## Summary Adds the Learning 1.0 production compatibility and migration guidance for AsiBackbone 6.0. This change establishes the documentation relationship between: - `AsiBackbone/Learning` 1.0 - `AsiBackbone/AsiBackbone` 6.0 and clarifies how readers should interpret earlier Learning material that references the 5.x implementation surface. ## Changes - Added a dedicated Learning 1.0 / AsiBackbone 6.0 compatibility guide. - Identified AsiBackbone 6.0 as the implementation baseline for Learning 1.0. - Documented the ownership boundary between Learning education and AsiBackbone runtime/API truth. - Summarized the major terminology refinements introduced for 6.0. - Added representative 5.x → 6.0 public API rename guidance. - Summarized the seven removed compatibility members that affect older examples without duplicating the full upstream migration guide. - Linked directly to authoritative AsiBackbone 6.0 migration, naming, terminology, and implementation documentation. - Documented the architectural concepts that remain stable across the major-version transition. - Clarified how historical Learning releases and 5.x-oriented content should be interpreted. - Added compatibility-guide links to: - root README - Getting Started - main DocFX navigation - Getting Started navigation ## Documentation Boundary Learning continues to own architecture education, terminology explanation, tutorials, and conceptual guidance. `AsiBackbone/AsiBackbone` remains authoritative for: - released public APIs - namespaces and signatures - runtime behavior - configuration - compatibility - migration requirements - implementation semantics All implementation references added by this change target the `release/6.0.0` branch rather than `main`. ## Validation - `git apply --check` passed against `release/1.0.0` - `git diff --check` passed - Documentation links reference the AsiBackbone `release/6.0.0` production baseline Closes #341 * fix: align Learning 1.0 API validation with AsiBackbone 6.0 (#346) ## Summary Fixes the AsiBackbone 6.0 API-reference validation failures introduced by the new Learning 1.0 compatibility guidance. The compatibility documentation intentionally contains historical 5.x API names so readers can understand the 5.x → 6.0 migration, but the validator previously treated those historical references as invalid current API usage. This change also corrects the documented 6.0 endpoint-policy attribute name to match the finalized `AsiBackbone/AsiBackbone` `release/6.0.0` API. ## Changes - Updated `validate-asibackbone-6-api-references.cs` so: - the compatibility guide and API-boundary guide may contain explicitly historical 5.x symbols; - current instructional content remains protected from stale 5.x API names; - implementation links are still validated against `release/6.0.0`; - `RequireGovernancePolicyAttribute` is treated as a stale 5.x public type outside historical/reference documentation. - Updated the Learning 1.0 / AsiBackbone 6.0 compatibility guide to document: - `RequireGovernancePolicyAttribute` → `GovernancePolicyAttribute`; - the distinction between this public type rename and the seven obsolete-member removals; - the current route-builder replacement `MarkGovernancePolicy(...)`. - Updated the AsiBackbone 6.0 API boundary guide to: - include `GovernancePolicyAttribute` in the current API surface; - remove the incorrect statement that `RequireGovernancePolicyAttribute` remains supported; - clarify attribute-based endpoint metadata guidance. - Converted the validator regexes to `GeneratedRegexAttribute`-based implementations to avoid runtime regex compilation and resolve the related `SYSLIB1045` warnings. ## Implementation Baseline This change is built against: - `AsiBackbone/Learning` `release/1.0.0` - `AsiBackbone/AsiBackbone` `release/6.0.0` No references were taken from either repository's `main` branch for the compatibility contract. ## Validation - `git apply --check` passes. - `dotnet run --file tools/validate-asibackbone-6-api-references.cs` passes. - Validator reports: - `Validated AsiBackbone 6.0 API references across 350 instructional file(s)` - no AsiBackbone package references in the framework-neutral samples. - Historical 5.x migration references remain documented without weakening validation of current Learning content. * fix(docs): shorten compatibility guide description Keep the Learning 1.0 compatibility guide description within the 160-character metadata limit so documentation validation passes. Refs #341 * docs: complete Learning 1.0 release-readiness review Add the dated release-readiness record and final 1.0.0 release notes. Align project-status messaging and navigation with the production documentation baseline, and document validation evidence, known limitations, and remaining publication controls. Closes #342 * fix(release): finalize Learning 1.0 metadata and redirects Update citation, Zenodo, changelog, release notes, and readiness metadata for 1.0.0. Replace release-branch links with durable links and preserve renamed documentation and sample paths with redirects and compatibility pointers. Refs #339, #340, #341, #342 * fix(release): prepare validation for main merge * fix(docs): target AsiBackbone main branch * fix(release): validate prerelease links
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
1 participant
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.
Closes #340
Summary
Upstream baseline reviewed
Validation
dotnet restore Samples.slnx --locked-modedotnet build Samples.slnx --no-restore(0 warnings, 0 errors)dotnet format Samples.slnx --verify-no-changes --no-restore --verbosity minimaldotnet test Samples.slnx --no-build(300 passed)dotnet tool run docfx docs/docfx.json --warningsAsErrors(0 warnings, 0 errors)