chakra-core / ChakraCore

ChakraCore is an open source Javascript engine with a C API.
MIT License
9.13k stars 1.2k forks source link

Documenting ChakraCore's internals #6414

Open rhuanjl opened 4 years ago

rhuanjl commented 4 years ago

As part of improving the experience for contributors we should produce helpful documentation covering the logic of ChakraCore's internals. Including what the key data types are in each area and what key logical processes are used internally:

It would be good if multiple people could contribute to this, we'll need to think about exactly how it should all hang together but here's a rough list of the things we should document:

rhuanjl commented 4 years ago

Not detailed enough at all, but here's some draft introductory documentation on the Regex parsing and matching system: https://gist.github.com/rhuanjl/913e7bf4993cc8f07c04cf6de154f572