This task captures work required to bring the Lift Wing API documentation (currently on Wikitech and api.wikimedia.org) into alignment with the standard documentation patterns defined as part of FY25/26 API and documentation strategy. It excludes work related to OpenAPI-based reference documentation, which is tracked separately (see parent and related tasks).
Baseline metrics and other content analysis details for this API doc collection are at: https://www.mediawiki.org/wiki/Wikimedia_Technical_Documentation_Team/API_documentation_strategy/Gaps#Lift_Wing_API
IA requirements
- The landing page supports navigation to each of the types of content required by the guidelines.
- The sequencing of information in the navigation menu follows the sequence outlined in the guidelines.
- Each content page (including sandbox/explorer UI) supports navigation back to the API's landing page.
Content requirements
- The API doc collection has a landing page that includes each piece of content specified in the guidelines. Any content that doesn't appear on https://wikitech.wikimedia.org/wiki/Machine_Learning/LiftWing/API has been placed elsewhere for reasons specific to this API (see subsequent items about Quick Start and Authentication guides)
- The API overview section or page covers the minimum required content.
- Rate limits vary by user group (internal vs. external), so are covered in User Guides instead in one Overview page/section. Eventually this info will be centralized at https://www.mediawiki.org/wiki/Wikimedia_APIs/Rate_limits.
- The API doc collection includes a quick start tutorial.
- Quick Start instructions vary by user group, so the standard quick start content is embedded in the audience-specific User Guides.
- The API doc collection includes an authentication how-to guide.
- Only relevant for external users, so included only in the external User Guide. Relies on the general Wikimedia auth guide: https://api.wikimedia.org/wiki/Authentication
- The API doc collection includes recipes or real-world examples for common tasks
- Updated quick start examples to highlight different query structure for models.
- Added links to self-contained / stand-alone featured apps that show working code using the API.
- Created a new ORES to Lift Wing migration guide that integrates and clarifies specific tasks for migration.
- The API doc collection includes a changelog.
- Links to the unified changelog.
- The API's documentation content follows the Wikimedia documentation style guide.