Skip to content

docs(api): replace generic contracts with actionable lifecycle and failure semantics #18

Open

Description

@FLwolfy

Documentation quality gap

The XML/Wiki syntactic gates pass, but some public summaries and parameter descriptions remain generic templates. Correct signatures, tags and compilable examples do not establish that callers understand ownership, concurrency, failure, missing state or reload constraints.

Owner: each API's source project and corresponding Wiki page, with existing architecture/Wiki validation retained.

Work

Prioritize public resource, build, scripting, plugin, identity, history and extension contracts. Review actual callers and execution chains. State ownership transfer, borrowing, cancellation, thread/safe-point requirements, partial failure, nullable outcomes and generation retirement where applicable. Do not invent guarantees or document internal APIs as stable public contracts.

Acceptance

  • Meaningful English public/protected XML and synchronized current Chinese Wiki guidance.
  • Small compilable examples cover success and important failure/lifetime cases.
  • Public API coverage, links, reference grouping and Wiki compilation remain valid.
  • Review evidence distinguishes semantic review from automated syntax checks.

Evidence: documentation risk recorded in records/architecture/acceptance/FULL_ENGINE_AUDIT_2026_10_24.md.

Editor UI subset tracked by #27 and #39

Review every API changed by the Editor UI closure, including Graph presentation, frozen compiler inputs and lifecycle changes. Document ownership, thread/borrow boundaries, cancellation, failure, Missing and generation semantics with current examples. This subset does not complete the repository-wide documentation audit. PR #26 must use Refs #18 unless the full original acceptance is independently achieved.

Activity

  1. FLwolfy commented on Oct 30, 2026

    @FLwolfy
    MemberAuthor

    The Editor UI subset of this broader documentation issue is verified on dbae93e8f211d45a69cdffdb6afa3a33a0af0fa5 through PR #26: neutral Graph presentation, frozen script inputs, Core capture/member/proof APIs, default layout input, AtomicFile.IsCandidatePath and existing AtomicDirectory.Install cancellation now have current ownership, borrowing/thread, cancellation, failure/rollback, Missing and generation semantics in XML/Wiki and the final report. Full exact-head Windows/macOS CI, architecture/XML and compiled examples pass. Evidence.

    This is not a repository-wide semantic-documentation completion claim. PR #26 uses Refs #18, not Fixes; this broader issue remains Open. No automatic merge is authorized.

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

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions