Skip to content

Update the Unity SDK documentation #1993

Closed as not planned
Closed as not planned

Description

@adrianbobis-blip

Restructure and update the AltTester® Unity SDK documentation, as part of #328.

Scope

Adopt the four-tier structure used across all three doc sites — Introduction → Get started →
Guides → Reference
— and split the two pages that carry most of the navigation problem.

Today After
commands.md, 11,201 lines, every class and all four languages 11 reference pages
advanced-usage.md, ten unrelated topics under one heading 10 guides
14 pages total ~43

Also in scope:

  • De-duplicate the parameter tables. 196 of 212 are the same table repeated once per language;
    only names and types genuinely differ, so those are merged per language and the descriptions
    stated once.
  • New pages with no current equivalent: Writing reliable tests, Choosing a selector,
    Errors (28 driver exception types, none documented today), How it works, Requirements,
    Next steps.
  • A landing page that states a path rather than listing fourteen siblings.

Notes

A full draft exists and builds locally — 49 pages, no new Sphinx warnings. It needs review before
anything is opened as a PR.

Every URL changes. A redirect decision is needed before publishing; Sphinx generates none.

Activity

  1. adrianbobis-blip commented on Sep 24, 2026

    @adrianbobis-blip
    Author

    Replaced by alttester/AltTester-Unity-SDK-Closed-Source#318, where the Unity SDK docs are maintained.

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

Metadata

Metadata

Labels

2.3.3documentationImprovements or additions to documentation

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions