Re our recent discussions about generating and publishing docs: Begin forwarded message:
> From: Eric Shepherd <[email protected]> > Subject: Re: Improvements to the Sphinx in-tree documentation generation > Date: 16 December, 2013 12:40:30 PM PST > To: dev-platform <[email protected]>, Gijs Kruitbosch > <[email protected]>, Firefox Dev <[email protected]>, Gregory > Szorc <[email protected]> > > On December 16, 2013 at 1:21:06 PM, Gregory Szorc ([email protected]) wrote: >> I agree our current mechanism for JS documentation is pretty bad. We >> desire to document both the source and MDN for obvious reasons. But >> nobody wants to burdened with writing docs twice. So typically in-tree >> or MDN docs suffer. Neither is great for maintainability or consumers. >> IMO we should just write in-tree source docs and export to MDN. Goodbye >> syncing problem. > > We have plans to add support to MDN for allowing content to be "pushed" onto > MDN from other sites using scripts or the like. There is already the > beginnings of a "write" API that allows content to be injected into MDN, and > with that in concert with permissions management, it would be possible to set > up the JSAPI section of MDN such that it was pushed onto the wiki by a tool > that interpreted in-source comments and output HTML formatted for the wiki. > > This could be a "best of both worlds" scenario that you guys could be quite > happy with. > > The only reason we haven't finished implementing support for this is that no > teams have stepped up to say they'd definitely use it; once one does, I think > it wouldn't take all that terribly long to complete, since much of the > underlying functionality is partly or even mostly implemented. > > -- > Eric Shepherd > Developer Documentation Lead > Mozilla > Blog: http://www.bitstampede.com/ > Twitter: http://twitter.com/sheppy
_______________________________________________ mobile-firefox-dev mailing list [email protected] https://mail.mozilla.org/listinfo/mobile-firefox-dev
