Commit Graph

127 Commits

Author SHA1 Message Date
Arseny Kapoulkine
650dd30062 Update getting-started and why for open source release 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
4d168c3543 Add CONTRIBUTING.md and replace README.md
Also add SVG logo to docs/
2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
33cb9d5991
Update performance.md (#94)
Add documentation on shorter atomic pauses

Co-authored-by: vegorov-rbx <75688451+vegorov-rbx@users.noreply.github.com>
2021-11-01 12:08:01 -07:00
vegorov-rbx
e562596bb8
Luau Recap: October 2021 (#92)
* Draft for October post

* Rebuild pages

* Apply suggestions from code review

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>

* Update 2021-10-31-luau-recap-october-2021.md

Add optimizations

* Remove unfinished section

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-10-29 11:37:43 -07:00
dcope-rbx
c1654e34eb
Fixed doc issue that was unaddressed in a previous code review (#93) 2021-10-29 09:48:58 -07:00
dcope-rbx
1b38e3c8f8
Added syntax documentation for if expressions (#91)
* Added syntax documentation for if expressions
2021-10-28 13:44:04 -07:00
Alan Jeffrey
f3a248d1a9
Remove warning about generic functions being disabled (#90) 2021-10-27 11:24:47 -05:00
Arseny Kapoulkine
2341b5014e
Update compatibility.md
Given the new RFC we clearly don't think coroutine.close is never going to happen :)
2021-10-26 17:19:37 -07:00
Arseny Kapoulkine
1ec7be600c
docs: Create library.md (#87)
Full documentation for the standard library, written from scratch by looking at the source code - so hopefully this is reasonably correct/precise.

Some of the function descriptions are probably too concise to be easily understandable - we can flesh this out in the future.

Some of the type specifications aren't using valid Luau syntax; in particular, I've used "function" or "table" in a few places as a human-friendly notion that any function/table suffices, and the iterator functions just say that they return <iterator> without being specific as to what the signature of the generator is.
2021-10-19 13:54:44 -07:00
Alan Jeffrey
4b02be4e0e
September 2021 Luau Recap (#81)
* Added the September Luau Recap

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-09-29 15:05:14 -05:00
Arseny Kapoulkine
ae1c104fd1
Update performance.md (#71)
Add some information about the new GC pacer

Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>
2021-09-15 16:19:45 -07:00
Arseny Kapoulkine
4e6ca2531b
Update performance.md (#69)
Remove placeholder sections for performance optimizations - we'll just add individual optimizations to this document as we deploy them.
2021-09-15 16:07:16 -07:00
vegorov-rbx
c738ddc1f0
Luau Recap: August 2021 (#64)
* August post is ready

* Fixes

* Rebuild pages

* Apply suggestions from code review

Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>

* Update docs/_posts/2021-08-31-luau-recap-august-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Fix typo

* Mention additional optimizations

* Fix link

Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-08-31 22:16:33 +03:00
Arseny Kapoulkine
ad436994ba
Update performance.md (#65)
Call out table capacity prediction
2021-08-31 07:28:49 -07:00
Arseny Kapoulkine
bb8870a1d4
Update compatibility.md (#63)
Add a note about `pcall` - really the C limit is universal but it will most often be hit during either pcall or coroutine.resume.
2021-08-30 10:31:52 -07:00
Arseny Kapoulkine
81cddbd82c
Update lint.md (#58)
Add documentation for DuplicateLocal
2021-08-04 15:24:25 -07:00
Matthew Pagan
9cc9934370
fix: change variable asserted in documentation (#60) 2021-08-04 09:25:01 -07:00
vegorov-rbx
e9db7cd1dc
Luau Recap: July 2021 (#59)
* July post is ready

* Trigger a build

* Trigger a build

* Added a paragraph for 'DuplicateConditions' lint

* Apply suggestions from code review

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Fix mixed tabs and spaces

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-07-30 19:52:21 +03:00
Arseny Kapoulkine
1f548d4753
Update lint.md (#54)
Add documentation for the upcoming DuplicateCondition lint
2021-07-21 16:13:04 -07:00
vegorov-rbx
01d9f8daf9
Luau Recap: June 2021 (#53)
* Template for the June post

* June post is ready

* Fixed post date

* Added a few examples

* Add another equality operator

* Update docs/_posts/2021-06-30-luau-recap-june-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Note the limitation of current constraint resolver

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-07-07 19:45:01 +03:00
Arseny Kapoulkine
bf17b6447a
Update lint.md (#52)
* Update lint.md

Add documentation for DeprecatedApi (live) and TableOperations (ships on July 7th)

* Update lint.md

Shorten line a bit
2021-07-06 09:06:51 -07:00
Arseny Kapoulkine
c8af786b10
Update compatibility.md
We decided that we can't enforce strict limits for insert/remove based on analysis of Roblox games
2021-06-15 19:05:27 -07:00
Arseny Kapoulkine
b439c9fcdc
Update performance.md
Restore the original sentence with tweaks; this seems like better wording since it highlights the importance of knowing the field name at compile time, no matter the notation.
2021-06-14 18:54:47 -07:00
Arseny Kapoulkine
40a175499e
Update performance.md
Remove outdated statement about table["field"] since we optimize it now the same way as table.field.
2021-06-14 10:53:26 -07:00
Arseny Kapoulkine
0fdf8824f1
Update performance.md (#50)
Add a section about vectors and libraries
2021-06-11 14:10:55 -07:00
Arseny Kapoulkine
50c22abae0
Update syntax.md (#46)
Add documentation for named arguments in function types.
2021-06-02 13:19:46 -07:00
Arseny Kapoulkine
b20601af89
Update lint.md (#44)
Update FunctionUnused and ImportUnused following internal changes that make it possible to suppress the warning using _
2021-06-02 12:49:35 -07:00
Arseny Kapoulkine
b490373454
Update syntax.md (#45)
Add information about type ascription syntax
2021-06-02 12:14:24 -07:00
vegorov-rbx
2a29ba1538
Update 2021-05-31-luau-recap-may-2021.md 2021-06-02 19:50:57 +03:00
vegorov-rbx
5c7a981866
Luau Recap: May 2021 (#42)
* Added May 2021 recap post

* Added missing items and fixed confusing function declaration example

* Apply suggestions from code review

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Small fix

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-06-02 13:19:15 +03:00
Arseny Kapoulkine
fff104b439
Rename linting pass to match internal changes
The name is cleaner and more correct
2021-05-30 11:55:52 -07:00
Andy Friesen
fc4cfede58
Document how to actually use an exported type from another module. (#40) 2021-05-28 10:31:47 -07:00
Arseny Kapoulkine
b2b0c33b5e Update CNAME 2021-05-27 19:00:09 -07:00
Arseny Kapoulkine
a4fe638b17 Create CNAME 2021-05-27 18:52:43 -07:00
Arseny Kapoulkine
d6ca8b2ce3 Delete CNAME 2021-05-27 18:33:38 -07:00
Arseny Kapoulkine
d3b551e266 Create CNAME 2021-05-27 18:32:05 -07:00
Arseny Kapoulkine
cbc99c3222
Update syntax.md
Fix typo: `nunber` -> `number`

Fixes #35.
2021-05-04 18:57:48 -07:00
vegorov-rbx
b8627707c4
Luau Recap April 2021 (#28)
* Base for the April post

* Finished April 2021 recap post

* Removed features that are not enabled yet (bye, type-checking section)

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Added 'Coming Soon' for type refinements

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-05-03 23:05:05 +03:00
Arseny Kapoulkine
93fb768a64
Update compatibility.md
Add a note about os.time
2021-04-26 14:13:20 -07:00
Arseny Kapoulkine
258966863c
Update compatibility.md (#27)
Call out the upcoming change to `print` and slightly reword a couple of rows. Also add a list of differences from 5.x that was previously requested (the list is likely incomplete)
2021-04-21 10:42:27 -07:00
Andy Friesen
bf63d29c9a
Document the duplicate function lint (#26) 2021-04-14 14:29:28 -07:00
canada
149e687d73
Add missing bracket (#25) 2021-04-12 08:44:43 -07:00
Arseny Kapoulkine
51758557e6
Update performance.md
Correct performance note re: table.insert after a recent update.

Fixes #23.
2021-04-02 22:37:23 -07:00
Arseny Kapoulkine
094d5a0e09
Update 2021-03-29-luau-recap-march-2021.md 2021-03-31 20:13:19 -07:00
Arseny Kapoulkine
8d712c47b6
Update typecheck.md 2021-03-31 20:12:43 -07:00
Andy Friesen
2d641976ee
Clip references to Array<T> (#21)
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-31 14:24:44 -07:00
Alan Jeffrey
0ab29a02e2
Add Atom feed (#22) 2021-03-31 14:24:26 -07:00
Alan Jeffrey
0b6977554b
Added section on generic functions (#20) 2021-03-31 12:53:21 -07:00
Alan Jeffrey
73b34e15c0
Luau Recap March 2021 (#19)
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-30 16:45:51 -07:00
ccuser44
e051e33482
Removed incorrect info (#14)
* Removed incorrect info

The manual says Luau does not support hexadecimal \0x, Unicode \u and \z
when this clearly isn't the case.
This is also quite confusing as just a bit below it says it does support them.

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-30 15:54:58 -07:00