https://bugzilla.wikimedia.org/show_bug.cgi?id=46526

Quim Gil <[email protected]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |[email protected]

--- Comment #6 from Quim Gil <[email protected]> ---
Ok, I have removed this proposal as a GSOC 2013 candidate. I still believe it
is worth discussing the proposal, though.

"Develop clear documentation and APIs to enable developers to create
applications that work easily with MediaWiki" is a top WMF priority according
to
http://strategy.wikimedia.org/wiki/Wikimedia_Movement_Strategic_Plan_Summary/Stabilize_Infrastructure

API documentation is usually written in the source code. "Keep documentation
close to the code" is a general principle of good open source software
development. This request is about "system documentation", tutorials et al are
different beats, out of scope here.

About L10n, I'm sure we are not the first project with this problem. It is a
convention to document in source code in English. Localization of source code
exists but afaik it focuses in UI strings, no docs (but I could be wrong). If
the docs would be exported to MediaWiki pages, then you could have your
translation point there, using the same workflow being used e.g. at
mediawiki.org. The fact that the English / source page is updated manually or
by a sync with source code shouldn't be relevant to translators. They would get
the same notifications when new updates are available, and the UI of those wiki
page would have the same language bar we have for manually updated pages.

Of course a main point to argue is whether we can just keep using
https://en.wikipedia.org/wiki/Doxygen and integrate https://doc.wikimedia.org/
better to mediawiki.org.

And I agree with hashar that having good docs (in whatever form) is the first
priority, otherwise the doc tools are just pointless. This is why I digged that
URL reminding us what are our top priorities until 2015.

-- 
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to