Skip to content

1.0: Update API references, samples, and examples for AsiBackbone 6.0 #340

Description

@cdcavell

Summary

Update Learning so all current API-facing instructional content reflects the finalized AsiBackbone/AsiBackbone 6.0 public surface.

Learning 1.0.0 should not ship with examples that compile only against 5.x, reference APIs removed at the 6.0 boundary, or present superseded names as current behavior.

Coordination

Coordinate with:

  • AsiBackbone/AsiBackbone#782 — public API naming refinement;
  • AsiBackbone/AsiBackbone#783 — obsolete API removal;
  • any 6.0 migration guide and finalized API baseline in the implementation repository.

Scope

Review current Learning content for:

  • public type names renamed for 6.0;
  • obsolete methods, constructors, aliases, or extension methods removed in 6.0;
  • namespace or package moves;
  • sample code that mirrors implementation APIs;
  • illustrative snippets whose names collide with real 6.0 types;
  • links to 5.x-specific API/reference pages;
  • comments or prose that describe no-longer-supported compatibility paths.

At minimum, verify all references to known 6.0 removal areas such as:

  • obsolete partial DefaultAsiBackbonePolicyEvaluator<TContext> constructors;
  • obsolete RequireGovernancePolicy route-builder overloads in favor of MarkGovernancePolicy;
  • public types renamed by the 6.0 semantic-domain naming review.

Executable samples

Where Learning owns executable samples:

  • update package references to the intended AsiBackbone 6.0 version;
  • update source to the supported 6.0 API;
  • preserve the educational objective of each sample;
  • update tests when a renamed API changes test names or setup;
  • verify restore, build, formatting, and tests.

Where snippets are intentionally illustrative rather than compiled:

  • clearly mark them as illustrative;
  • avoid using fictional type names that could reasonably be mistaken for released APIs;
  • link to the owning implementation documentation for exact current syntax.

Acceptance criteria

  • Final AsiBackbone 6.0 API rename/removal inventory is reviewed before implementation.
  • Current Learning code examples contain no calls to APIs removed in AsiBackbone 6.0.
  • Current examples use the finalized 6.0 public names and namespaces.
  • Executable samples restore, build, format-check, and test against the selected 6.0 package version.
  • Illustrative snippets are clearly distinguished from released API examples.
  • Links to API/reference documentation resolve to current 6.0 material.
  • Historical release/migration material remains historically accurate rather than being rewritten as if older APIs never existed.
  • Documentation-link validation and sample-validation workflows pass.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions