Skip to content
This repository has been archived by the owner. It is now read-only.

General documentation markdown cleanup #30

Closed
siddhesh opened this issue Nov 18, 2019 · 0 comments
Closed

General documentation markdown cleanup #30

siddhesh opened this issue Nov 18, 2019 · 0 comments
Labels
good first issue Good for newcomers

Comments

@siddhesh
Copy link
Collaborator

siddhesh commented Nov 18, 2019

The ported markdown documentation attempts to glean technical documentation that is relevant to moonjit such as installation and execution instructions, API, etc. It does not have benchmark numbers, sponsorship acknowledgements or contact details since they are not relevant to moonjit.

In the process however, a number of cross-links have gone missing and the port also may have errors, formatting and factual.

One needs to review the documentation, comparing with reality (i.e. actually verifying if it works) and also comparing with documentation in doc.luajit to fix any correctness issues and add cross links wherever relevant.

@siddhesh siddhesh added the good first issue Good for newcomers label Nov 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant