After some discussion on IRC, Eddy and I have started an Etherpad to collect things we might want to do to improve our docs: https://etherpad.mozilla.org/sm-doc
I made one thing the first entry in that list as I think it could be a big imrovement: How about getting someone to look at the docs from a usability POV? Structuring docs in such a way that they're accessible to newbies is quite a challenge, and from my recent experience with consuming them in that role, I know that our docs are far from perfect in that regard. Unfortunately, knowing that doesn't mean that I also know how to improve their structure in general. (And I don't really mean improving their content - it's clear that creating good documentation and keeping it up to date takes vast amounts of time.) On Mon, Jul 30, 2012 at 3:43 PM, Josh Matthews <[email protected]> wrote: > Thank you for writing this, Tom. These are excellent points you make, > and I'll toss out a couple more data points of my own. In my role of > the guy who responds to emails sent from the mozilla.org/contribute > form (coding-specific), when I see someone who declares an interest in > compilers/JITs/interpreters/etc., I suggest they take a look at the > https://wiki.mozilla.org/JavaScript:New_to_SpiderMonkey wiki page. > Feel free to point me to a better one, or give that one a thorough > going-over to ensure it's the best presentation of the material > possible. > > Cheers, > Josh > > On 30 July 2012 09:28, Tom Schuster <[email protected]> wrote: >> So yeah this has been on my mind for a very long time, and on a very >> long train ride I finally had time to write down some of these ideas. >> >> - Documentation >> We have some scattered documentation. A lot of stuff is outdated (eg. >> mentions TraceMonkey). We should try to update some of it and move >> them MDN. > _______________________________________________ > dev-tech-js-engine-internals mailing list > [email protected] > https://lists.mozilla.org/listinfo/dev-tech-js-engine-internals _______________________________________________ dev-tech-js-engine-internals mailing list [email protected] https://lists.mozilla.org/listinfo/dev-tech-js-engine-internals
