Commit Graph
19 Commits
Author SHA1 Message Date
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 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 5e63e65752 docs: flesh out Range class docs, fix grammar, add smarty plugin, and improve CLI description 2015-09-23 04:19:38 +00:00
Bob Nystrom c4ef964f92 refactor: move benchmark directory under test and update all references
The benchmark directory is relocated from the project root into the test directory, and all scripts, documentation links, and gitignore paths are updated accordingly. The test runner is also refactored to explicitly walk subdirectories (core, io, language, limit) instead of using a single test root, and a new test/README.md is added to document the test suite structure. Additionally, the constructor test for the Foo class is updated to add a zero-arity constructor and adjust expected output strings.
2015-03-14 19:45:56 +00:00
Bob Nystrom 222cddc751 fix: convert benchmark chart bars from scores to execution times
The benchmark HTML output previously displayed abstract "score" values and scaled bars by the highest score. This change replaces scores with the actual minimum execution time in seconds (e.g., "0.15s") and scales bar widths proportionally to the highest time, making the charts directly interpretable as performance comparisons. The `run_bench` script now computes `time` from `min(result["times"])` instead of `get_score()`, and the static performance documentation is updated to reflect the new time-based values.
2015-01-17 01:51:10 +00:00
Bob Nystrom 0c0f900cad fix: update benchmark numbers and bar widths in performance documentation
Update the Method Call and DeltaBlue benchmark tables with new Wren performance results (6748 and 7564 respectively), adjusting all other language scores and corresponding chart-bar width percentages to reflect the latest measurements.
2015-01-16 15:52:51 +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 722ca8f61d docs: expand contributing guide with MIT license and GitHub links, reword error handling and performance sections 2015-01-02 04:45:15 +00:00
Bob Nystrom ee9d10f5f5 fix: update benchmark chart values for method call and delta blue tests
The performance numbers in the documentation's benchmark chart have been refreshed to reflect the latest measurements. Method call results now show wren at 5100 (up from 4930), luajit at 4441 (up from 4266), ruby at 2868 (up from 2752), lua at 1742 (up from 1728), python3 at 884 (up from 865), and python at 779 (up from 764). DeltaBlue results show wren at 7006 (up from 6662) and python3 at 2333 (down from 2336).
2014-12-07 22:34:17 +00:00
Bob Nystrom 235518637a style: update site color scheme, typography, and copy across documentation pages 2014-08-19 14:35:20 +00:00
Bob Nystrom bbd4cc0f56 feat: add benchmark chart visualization to performance page
Refactor benchmark runner to store results in a nested dict keyed by language name, enabling per-benchmark result aggregation. Add bar chart HTML tables to doc/site/performance.markdown displaying method call, DeltaBlue, and binary trees benchmarks across languages. Include SCSS styles for chart layout, bar coloring, and main content padding.
2014-04-21 04:04:41 +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 71783400ae docs: add documentation for conditional operator, fibers, break statements, and ranges; remove placeholder usage page 2014-04-11 17:45:20 +00:00
Bob Nystrom e8d31eddaf feat: replace hand-written CSS with Sass compilation and update site design with new fonts and layout
- Delete doc/site/style.css and add doc/site/style.scss with Sass variables, Dosis header font, box-sizing, absolute header positioning, and link hover effects
- Update template.html to reference Dosis font, lowercase nav headings, and change tagline to "a classy little scripting language"
- Add .sass-cache/ to .gitignore and rename Makefile phony target from docs to builtin
- Modify generate_docs.py to compile style.scss via sass subprocess instead of copying static CSS
- Tweak performance.markdown and qa.markdown for minor wording improvements
2014-04-05 22:39:02 +00:00
Kyle Marek-Spartz 86029c5123 docs: replace em dash with unicode character and semicolon with colon in two markdown files 2014-02-17 19:56:41 +00:00
Kyle Marek-Spartz 91f890e0cc docs: replace em dash, hyphenate compound adjective, and use colon in documentation 2014-02-17 01:28:40 +00:00
Kyle Marek-Spartz 5ccf0546c1 fix: correct spelling of "rivaling" and "carnival" in performance documentation
Fix two typos in doc/site/performance.markdown: change "rivalling" to "rivaling" in the paragraph about language implementation complexity, and change "carvinal" to "carnival" in the benchmarks section.
2014-02-15 23:12:18 +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
Bob Nystrom 813cbbc5a2 docs: add initial performance documentation covering Wren's speed and value representation
Create new doc/site/performance.markdown explaining Wren's position in the bytecode interpreter performance bucket and introducing NaN tagging for compact value storage. Also update doc/site/template.html to include a link to the new performance page in the "Other" navigation section.
2013-12-11 05:51:58 +00:00