Should the possibility to pair API documentation with user comments become a requirement for this project? Sounds like a good idea, also very much in line with the MediaWiki/Wikimedia practice tradition of having discussion pages next to content pages.
URLs of examples are welcome.
qgil wrote on 2014-07-31 21:45:25 (UTC)
At T491#11 I'm proposing to find a way to publish API docs in MediaWiki pages, which would allow us to just use the related Talk pages (with Flow).
As I've been wading through all of the discussion in the various Phab tickets as soon as I saw this requirement I immediately thought, "wait, MediaWiki Talk pages provide this already". Therefore, my opinion for API presentation is in agreement with qgil here in that figuring out how to use MediaWiki would be beneficial.
For the record:
The main use case is: "I have a question using this API, where can I ask?". The reply might become a useful part of the documentation, as a simple reply or as a patch/diff to the existing documentation.
If discussion wiki pages are not a good solution for this, then we need a good solution.
Also @GWicke says it is a good idea while @Krinkle thinks it never works. We need a commonly agreed opinion. :)
This is not a critical feature for T101441, so I will detach it from our short term plans.
The Web-APIs-Hub project is dead hence mass-declining its tasks to reflect reality. It might be superseded by a Developer Portal in the future.