Skip to content

Documentation is moved to docs. #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2016

Conversation

ktorpi
Copy link
Contributor

@ktorpi ktorpi commented Jun 22, 2016

  • DEVELOPEMENT.md is extended with bash utilites
  • Internals doc added and DEVELOPEMENT.md is renamed to GETTING-STARTED.md
  • modified image links in Internlas
  • links are fixed in README.md

@zherczeg
Copy link
Member

Signed-off-by message is incorrect. Please fix it.

LGTM after that

@LaszloLango LaszloLango added enhancement An improvement documentation Related to documentation labels Jun 22, 2016
@ktorpi ktorpi force-pushed the documentation_emplacement branch 2 times, most recently from 52ff017 to ff642f4 Compare June 29, 2016 09:02
@LaszloLango
Copy link
Contributor

LGTM

# High-Level Design
![High-Level Design](img/engines_high_level_design.png)

On the diagram above is shown interaction of major components of JerryScript: Parser and Virtual Machine (VM). Parser performs translation of input ECMAScript application into the byte-code with the specified format (refer to [Bytecode](#byte-code) and [Parser](#parser) page for details). Prepared bytecode is executed by the Virtual Machine that performs interpretation (refer to [Virtual Machine](#virtual-machine) and [ECMA](#ecma) pages for details).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first sentence is a little bit funky. Maybe something like The diagram above shows interactions between major components...?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, I've fixed it.

@ktorpi ktorpi force-pushed the documentation_emplacement branch 2 times, most recently from cc127f2 to 818547e Compare June 29, 2016 09:30
@dbatyai
Copy link
Member

dbatyai commented Jun 29, 2016

LGTM

@tilmannOSG
Copy link

Spotted a couple of typos in the commit message:

DEVELOPEMENT.md is extended with bash utilites -> DEVELOPMENT.md is extended with bash utilities
Internals doc added and DEVELOPEMENT.md is renamed to GETTING-STARTED.md -> Internals doc added and DEVELOPMENT.md is renamed to GETTING-STARTED.md
modified image links in Internlas -> modified image links in Internals

Otherwise LGTM :)

@ktorpi ktorpi force-pushed the documentation_emplacement branch from 818547e to 69761da Compare June 30, 2016 11:27
@ktorpi
Copy link
Contributor Author

ktorpi commented Jun 30, 2016

I've updated the commit message.

@ktorpi ktorpi force-pushed the documentation_emplacement branch from 69761da to fe7e4c1 Compare June 30, 2016 11:29
 - DEVELOPMENT.md is extended with bash utilites.
 - Internals doc added and DEVELOPMENT is renamed to GETTING-STARTED.
 - modified image links in Internals
 - links are fixed in README.md

JerryScript-DCO-1.0-Signed-off-by: István Kádár ikadar@inf.u-szeged.hu
@ktorpi ktorpi force-pushed the documentation_emplacement branch from fe7e4c1 to 1b40af7 Compare June 30, 2016 12:35
@bzsolt bzsolt merged commit 1b40af7 into jerryscript-project:master Jun 30, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation enhancement An improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants