Jump to content

Topic on Talk:Stable interface policy/Frontend

Requiring documentation on docs.wikimedia.org

4
Jdlrobson (talkcontribs)

In Stable_interface_policy/Frontend#JavaScript_code we state "Note: Clearer documentation guidelines will be provided as part of phab:T138401."

I'd like to propose that stable code MUST be documented on docs.wikimedia.org. While using the stable tag is a helpful indicator, having it discoverable on the documentation is probably the most ideal situation.

One implication of this would mean that extensions/skins that provide stable APIs would need to publish documentation on docs.wikimedia.org.

What thoughts do people have on this?

TheDJ (talkcontribs)

I think I'd support this...

Jdforrester (WMF) (talkcontribs)

+1, seems a reasonable consequence of what we mean by "stable code".

Tacsipacsi (talkcontribs)

I’d say stable code SHOULD be documented on doc.wikimedia.org. In some cases, it may be more desirable to provide documentation on mediawiki.org pages or via other means. As you write, discoverability is the most ideal situation; other factors (like maintainability) may overrule this.

Reply to "Requiring documentation on docs.wikimedia.org"