Create docs folder and use .md for docs#19
Merged
lee2sman merged 7 commits intoL5lua:mainfrom Mar 21, 2026
Merged
Conversation
Contributor
|
Thanks for getting this started! It's on the right track, well done. Since language appears like it may have been adapted from the p5.js contributing README can you give a credit line for that at the bottom. Also, maybe a link to the website's Contributing doc? https://l5lua.org/contributing/ Basically, it should be clear to folks that the L5 repo is for L5 work, and the L5-Website is for the website work! Thank you! |
Nitish-bot
commented
Mar 18, 2026
|
|
||
| Please be sure to review our [principles](https://github.com/L5lua/L5/blob/main/docs/PRINCIPLES.md). These things are very important to us. | ||
|
|
||
| Check out the [contributor docs](https://l5lua.org/contributing/) for more in-depth details about contributing code, bug fixes, and documentation. |
Contributor
Author
There was a problem hiding this comment.
@lee2sman a link to the contributor docs is already here
Contributor
Author
|
All comments have been addressed |
Contributor
|
Thanks, I edited CONTRIBUTING.md and merged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR closes #15 and:
Doc files are usually named in all caps hence the change to the api filename. Both existing files were written using markdown format just with a
.txtextension so no changes were needed.The
CONTRIBUTING.mdfile is heavily inspired from p5.js, I have added a codebase overview section that explains the basic logic of the library and how it interops with Love2D.