Page MenuHomePhabricator

Provide documentation for cirrus-suggest API
Closed, DeclinedPublic

Description

There's barebones documentation in the API itself (e.g. https://en.wikipedia.org/w/api.php?action=help&modules=cirrus-suggest) and scattered across Phabriator tickets, but we should write something a little more comprehensive and put it on mediawiki.org.

We may want to wait until we're more sure about what our investment in the API would be. Given our initial tests (see T109729) show great promise, I'd wager that we'll be working on this for a while, so documentation should perhaps be done sooner rather than later. I'd prioritise this lower than actually getting the first A/B test of this running, though.

Event Timeline

Deskana raised the priority of this task from to Medium.
Deskana updated the task description. (Show Details)
Deskana subscribed.

We've decided to hold off on documenting this until we're more sure about where exactly it will live. The current location is one that was chosen to get it out as soon as possible. When we productionise this properly, we will document it.

Deskana claimed this task.

The API won't exist in the same form (i.e. it probably won't be "cirrus-suggest"), and will of course have documentation added to it, so this task can just be declined.