Commit Graph

20 Commits

Author SHA1 Message Date
underscorediscovery
d0666f5a14 docs: add logo to sidebar, fix footer positioning, and switch to em units for responsive consistency 2019-02-06 02:18:24 +00:00
Bob Nystrom
3452b70666 docs: update Wren documentation examples to use string interpolation and clarify fiber and method call semantics
- Replace string concatenation with interpolation in class method examples
- Remove backticks from Fiber class references in concurrency docs
- Add guidelines for choosing between getters and empty-parentheses methods
- Clarify block syntax for single-expression functions and chaining
2017-10-20 02:52:05 +00:00
Ian Mackenzie
d7e7428b85 fix: correct argument order in list.insert example within method-calls documentation
The example code snippet for method call syntax previously showed arguments in the wrong order (value before index). Updated to match the correct Wren API signature where the index parameter precedes the value parameter.
2016-04-15 05:16:24 +00:00
Bob Nystrom
58c7c735ed docs: add System.print calls to list examples, reword map docs, update method-calls and performance benchmarks
- Add System.print() wrapper to all list subscript and count examples in lists.markdown
- Reformat map literal alignment and reword description in maps.markdown
- Remove paragraph about fibers as map keys from maps.markdown
- Change method-calls example from "hello" to "Heyoo!" and reword VM execution description
- Update performance benchmark timings and bar widths across all test cases
2016-01-22 05:38:27 +00:00
Bob Nystrom
54d498ce5d fix: correct grammar and example errors in method-calls documentation
- Fix missing article "a" in "expose some stored or computed property"
- Fix missing relative pronoun "that" in "a method doesn't need any parameters"
- Replace incorrect example `list.clear` with `[1, 2, 3].clear` in getter/setter distinction section
- Simplify phrasing "without any collision" to "without a collision" in setters section
2015-12-30 06:29:13 +00:00
Bob Nystrom
909c242a03 chore: reorganize doc site structure by moving core docs under modules/ and removing category metadata
Restructure the documentation hierarchy to prepare for documenting additional built-in modules. Move all core library documentation from `doc/site/core/` to `doc/site/modules/core/`, rename `modules.markdown` to `modularity.markdown`, remove `^category` metadata lines from all affected pages, update cross-reference links to use relative paths under the new structure, and add a TODO placeholder to the Class class page.
2015-11-08 21:31:22 +00:00
Bob Nystrom
4562b2e497 docs: move precedence table from grammar page to syntax page with updated operator list and links 2015-11-08 18:59:23 +00:00
Bob Nystrom
1b2f11eec3 docs: remove outdated commented-out is operator documentation from method-calls page 2015-11-07 21:00:49 +00:00
Bob Nystrom
f27fff9dd0 docs: document is operator as overridable infix method and add type-test examples 2015-11-07 21:00:24 +00:00
Bob Nystrom
efcc4d07c7 docs: reorganize language guide into linear narrative with renamed sections and navigation links 2015-11-07 19:09:04 +00:00
Bob Nystrom
98d358142d docs: reflow all markdown files to 80-char width and add control-flow page with branching/looping content 2015-01-04 07:27:02 +00:00
Bob Nystrom
151b352bee docs: expand embedding API, functions, lists, maps, and looping documentation with examples and clarifications 2015-01-02 02:48:59 +00:00
Bob Nystrom
6ed15da597 feat: add category metadata to doc pages and switch code blocks to dart syntax
Add `^category` front matter to all language, types, and reference doc pages for site navigation restructuring. Replace `:::wren` and `:::java` code block annotations with `:::dart` across multiple files. Create new stub pages for core-libraries, embedding-api, and contributing under the reference category. Remove the old embedding and getting-involved stub pages.
2014-04-15 04:23:46 +00:00
Bob Nystrom
f291f2ca6e docs: replace IO.write with IO.print across multiple documentation files 2014-04-06 15:38:00 +00:00
Kyle Marek-Spartz
9dfcf530db docs: add TODO note to refactor classes and method-calls documentation with operator examples 2014-02-17 01:31:10 +00:00
Kyle Marek-Spartz
3b9478908f docs: update documentation examples to use uppercase IO instead of lowercase io 2014-02-16 17:28:56 +00:00
Bob Nystrom
1464007327 docs: add watchdocs target, stub pages for fibers/lists/maps, fix class example, and move build output to build/docs 2014-01-30 14:51:52 +00:00
Bob Nystrom
4026878ac6 docs: add branching, looping, classes, method calls, and Q&A documentation with updated navigation 2013-12-28 17:37:41 +00:00
Bob Nystrom
14b6eb04d2 docs: expand method-calls documentation with setters and operator sections, add is operator note to syntax page 2013-12-21 17:15:30 +00:00
Bob Nystrom
e26afd7de3 docs: add method-calls and variables pages, update sidebar links, revise statement-terminator and performance docs 2013-12-17 17:39:26 +00:00