1509082 - Add a top-level entry file to give a high level overview of SpiderMonkey.

Status: RESOLVED DUPLICATE of bug 1685958

(Core :: JavaScript Engine, enhancement, P3)

Description

[Nicolas B. Pierron [:nbp]]

SpiderMonkey is a complex project, with a lot of inter-operating parts. Any new contributor might have a hard time figuring out his way through the code base without a document to tell them how to navigate the code base and how each components interact with each others.

This document should be short and general enough, in to avoid having it bit-rot too fast. As such it should redirect the reader to other [SMDOC] entries and files for further details on each components.

To be consistent, we should probably prefix this file with something like:

  [SMDOC] __ DOCUMENTATION START HERE __

Other ideas might be to make it a markdown file to be rendered and viewed on gecko-dev repository, on github.

Comment 1

[Nicolas B. Pierron [:nbp]]

This wiki page describe a very-highlevel overview of a migration plan of js/src/ directory structure, which does not describes the components, nor their interactions.

  https://wiki.mozilla.org/JavaScript:SpiderMonkey:Directories

The top-level file to be completed with this bug should also mention the js/public directory content.