Skip to content

1.0: Publish a production documentation compatibility and migration guide #341

Description

@cdcavell

Summary

Create a Learning 1.0 production-baseline guide that explains how the educational documentation maps to AsiBackbone 6.0 and how readers should interpret older 5.x material.

The goal is not to duplicate the implementation repository's migration guide. Learning should explain the conceptual and educational impact of the 6.0 transition while linking to the implementation repository for exact API/runtime migration details.

Goals

  • State clearly that Learning 1.0 is the production documentation companion to AsiBackbone 6.0.
  • Explain which concepts remain stable across the transition.
  • Summarize terminology changes that affect how readers interpret current articles.
  • Call out public API naming/removal changes that materially affect examples.
  • Distinguish current production guidance from historical 5.x release material.
  • Preserve the ownership boundary: Learning teaches; AsiBackbone defines released API/runtime truth.

Suggested sections

  1. Version relationship — Learning 1.0 ↔ AsiBackbone 6.0.
  2. What changed conceptually — terminology and naming refinements.
  3. What changed in code examples — links to authoritative 6.0 migration/API docs.
  4. What did not change — governance model and architectural boundaries that remain stable.
  5. How to read older Learning content — historical versus current guidance.
  6. Where to verify exact behavior — implementation-repository links.

Compatibility statement

Document a simple support statement for the production baseline, for example:

Learning 1.0 documents and teaches the AsiBackbone 6.0 production surface. Earlier Learning releases remain historical educational records and may reference APIs or terminology that were valid in earlier AsiBackbone release lines.

Exact wording may be refined during implementation.

Acceptance criteria

  • A published Learning 1.0 compatibility/migration article exists.
  • The article explicitly identifies AsiBackbone 6.0 as the aligned implementation baseline.
  • Terminology changes are summarized without duplicating the full glossary.
  • API removals/renames that affect Learning examples are summarized and linked to authoritative AsiBackbone migration documentation.
  • Stable architectural concepts that survive the major-version transition are identified.
  • Historical Learning releases are clearly distinguished from current production guidance.
  • README, Getting Started, release documentation, and/or site navigation link to the compatibility guidance where appropriate.
  • All implementation links resolve and documentation-link validation passes.

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