Repository navigation
docs: restructure into four tiers and de-duplicate the reference - #1994
Closed
adrianbobis-blip wants to merge 7 commits into
Closed
adrianbobis-blip wants to merge 7 commits into
adrianbobis-blip wants to merge 7 commits into
Conversation
Introduction -> Get started -> Guides -> Reference, matching the structure proposed for all three sites so that learning one teaches the others. commands.md was 11,201 lines holding every class for all four languages, and becomes eleven reference pages. advanced-usage.md held ten unrelated topics under one heading and becomes ten guides. get-started.md becomes four sequenced pages ending in Next steps. The parameter tables are de-duplicated. 196 of 212 were the same table repeated once per language; names and types genuinely differ between C#/Java and Python/Robot, so those are merged per language inside one row and the descriptions are stated once. That removes about a third of the reference without losing content, and means a description no longer has to be edited four times. New pages with no current equivalent: Writing reliable tests, Choosing a selector, Errors (28 driver exception types, none documented before), How it works, Requirements and Next steps. Also includes the two fixes needed for the tree to build: _templates/layout.html used the pre-Sphinx-4 CSS API and aborted the build, and the three iOS literalinclude targets never existed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Links that still named the old single pages (commands.html, advanced-usage.html, get-started.html, contributing.html) now go straight to the page that holds the section, instead of relying on a redirect. Also renders two FAQ summaries' inline code as <code>, since backticks inside raw HTML are not converted. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Every old latest/ URL would otherwise 404, and several can no longer be edited: the PyPI README of every released driver, the URL compiled into shipped Unreal plugins, and the comment the Desktop recorder writes into users' tests. The build now writes a small page at each old path. The #anchor never reaches the server, so the page resolves it in the browser: commands.html#click lands on the Click section of input-actions.html. legacy-redirects.json maps all 16 old pages and every anchor they had in any published version (493). Pages that were split with no anchor show a list of where their content went, rather than guessing one. Only the build that contains the map writes pages, so the versioned builds are unchanged. The build warns if a target section is renamed later, or if an old path becomes a real page again. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Desktop docs link was built as "desktop/v." + this SDK's newest tag, so every version linked desktop/v.2.3.2/, which does not exist (Desktop's folder is 2.3.2) and returns 404. Every published version is rebuilt with the current conf.py on each deploy, so this fixes the link in all of them at once. The sidebar's Home Page and Desktop entries were hardcoded to sdk/2.3.2/ and desktop/v.2.2.4/. The deploy rewrites them to latest/ for the latest build only, so the next release tag would have shipped the stale ones. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Both files are the document "home", so Sphinx builds only one. The Sphinx 4.5 pinned in CI picks home.rst, whose table of contents lists the pages the restructure removed, so every sidebar on the deployed site would show none of the new pages. Its one paragraph is already in home.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
40 in-page links such as [By](#by-selector) stayed behind when the reference and Advanced Usage were split, so they landed at the top of their own page; they now name the page that holds the section. Two of them, on Reverse port forwarding, pointed at headings renamed before the restructure. Dead external links: the Linux batchmode download had a ® inside its URL; the macOS and Windows v2.2.4 packages are no longer hosted, so they go to the downloads page; the Appium XCUITest capabilities, allure-csharp examples, AltId.cs, BrowserStack BaseTest.cs and 1.7.0 changelog moved; the BitBar free trial page now lives on the BitBar product page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
#1731 removed it from conf.py while removing the Unreal pages. Every version is built with the current conf.py, so the 1.8.0 upgrade guide (all versions) and the 2.1.0-2.2.0 front pages show the raw text :alttestersdkdownload:`our website <>` instead of a link. It now points at the downloads page; the per-version package it used to link is gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Author
|
Moved to alttester/AltTester-Unity-SDK-Closed-Source#319. The Unity SDK docs are maintained in the closed-source repo and synced here, so a change made only in this repo would be undone by the next sync. |
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 #1993
Restructures the documentation into Introduction → Get started → Guides → Reference, the same
four tiers proposed for all three sites.
16 pages → 45. Nothing is deleted; every existing page has a destination.
What moves
commands.md, 11,201 lines, every class for all four languagesadvanced-usage.md, ten unrelated topics under one headingget-started.mdnext-stepsThe reference is de-duplicated
196 of 212 parameter tables were the same table repeated once per language. They are merged.
Names and types are kept per language, because they genuinely differ — Python and Robot
rename parameters (
by→locator_strategy,value→locator) and change types(
AltVector2→list/tuple/dict). Only what is actually shared — Required and Description — isstated once:
Where descriptions genuinely differ, the tabs are left untouched — 44 of 55 groups merged, 11
kept. The reference drops from 36,797 to 23,721 words with no content lost, and a description no
longer has to be edited four times to change it once.
What is new
Writing reliable tests, Choosing a selector, Errors (28 driver exception types, none
documented today), How it works, Requirements, Next steps.
Also included
The two fixes the tree needs in order to build, previously #1992:
_templates/layout.htmlused the pre-Sphinx-4 CSS API and aborted the build with zero pages.literalincludetargets never existed, leaving the iOS tab blank.ServerLogManager→AltTesterLogManager, which Closed-Source renamed on 2026-07-24.Setup
Checks
Before merging
Every URL changes; Sphinx generates no redirects, so that needs deciding first.
The docs are authored in the Closed-Source repo and synced here. This PR is against the repo that
builds and publishes; the same restructure will need to reach the authored copy, or the next sync
will revert it.
🤖 Generated with Claude Code