diff --git a/web/documentation/arrays.md b/web/documentation/arrays.md index c5c45dd..c21d3e4 100644 --- a/web/documentation/arrays.md +++ b/web/documentation/arrays.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Arrays in Fun @@ -10,21 +10,16 @@ description: Working with arrays, creation, indexing/slicing, iteration patterns permalink: /documentation/arrays/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- arrays +- creation +- helpers +- idioms +- indexing +- iteration +- patterns +- slicing --- -# Arrays in Fun This guide focuses on arrays: creation, indexing, mutation, iteration, slicing, and common gotchas. It complements the quick overview in types.md with a deeper, example‑driven treatment. diff --git a/web/documentation/asyncio.md b/web/documentation/asyncio.md index c04af73..d1d5c9b 100644 --- a/web/documentation/asyncio.md +++ b/web/documentation/asyncio.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Async I/O ("asyncio") in Fun @@ -10,21 +10,19 @@ description: Async I/O primitives and patterns, non-blocking sockets, fd polling permalink: /documentation/asyncio/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- async +- asyncio +- best +- blocking +- examples +- non +- patterns +- polling +- practices +- primitives +- sockets --- -# Async I/O ("asyncio") in Fun This guide explains the new asynchronous I/O primitives in Fun and how to use them to build non-blocking network and file descriptor workflows. It covers the core concepts, available helpers, common patterns, and runnable examples from the repository. diff --git a/web/documentation/build.md b/web/documentation/build.md index 95552aa..3abb6f3 100644 --- a/web/documentation/build.md +++ b/web/documentation/build.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Building Fun @@ -10,21 +10,19 @@ description: How to build Fun with CMake, available targets, and build options ( permalink: /documentation/build/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- available +- build +- building +- cmake +- fun_debug +- fun_use_musl +- fun_with_cpp +- fun_with_openssl +- fun_with_rust +- options +- targets --- -# Building Fun This guide describes how to build Fun from source using CMake and the available build options. diff --git a/web/documentation/bytecode-format.md b/web/documentation/bytecode-format.md index 1014c69..1011692 100644 --- a/web/documentation/bytecode-format.md +++ b/web/documentation/bytecode-format.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Bytecode Format (Overview) @@ -10,21 +10,15 @@ description: Reference for the bytecode format (split out from internals for con permalink: /documentation/bytecode-format/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- bytecode +- convenience +- format +- internals +- out +- reference +- split --- -# Bytecode Format (Overview) This document summarizes the Fun bytecode format. For deep VM details, see [internals.md](./internals/). diff --git a/web/documentation/cli.md b/web/documentation/cli.md index 794dee0..4789326 100644 --- a/web/documentation/cli.md +++ b/web/documentation/cli.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun CLI @@ -10,21 +10,19 @@ description: Command-line usage of the `fun` executable, synopsis, options, exit permalink: /documentation/cli/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cli +- codes +- command +- executable +- exit +- includes +- library +- line +- options +- paths +- synopsis --- -# Fun CLI Reference for the `fun` command-line interface. diff --git a/web/documentation/contributing.md b/web/documentation/contributing.md index e12113d..957f988 100644 --- a/web/documentation/contributing.md +++ b/web/documentation/contributing.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Contributing to Fun @@ -10,44 +10,43 @@ description: How to contribute, project structure, coding style, running tests, permalink: /documentation/contributing/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- coding +- contribute +- contributing +- guidelines +- project +- running +- structure +- style +- tests --- -# Contributing to Fun Thanks for your interest in contributing! This guide covers the basics to get you productive quickly. ## Getting started -- Clone the repo and build (see [build.md](./build/)). -- Run tests locally (see [testing.md](./testing/)). -- Explore examples (see [examples.md](./examples/)). +- Clone the repo and build (see [build/](../build/)). +- Run tests locally (see [testing/](../testing/)). +- Explore examples (see [examples/](../examples/)). ## Project structure -- `src/` - C core, VM, and opcode implementations ([src/vm](../src/vm/)). +- `src/` - C core, VM, and opcode implementations ([https://git.xw3.org/fun/fun/src/branch/main/src/](https://git.xw3.org/fun/fun/src/branch/main/src/){:class="git"}). - `lib/` - Standard library written in Fun. +- `web/` - Website and documentation ([https://git.xw3.org/fun/fun/src/branch/main/web/](https://git.xw3.org/fun/fun/src/branch/main/web/){:class="git"}). - `examples/` - Example programs and showcases. -- `documentation/` - Documentation. - `spec/` - Language specification drafts. +- `cmake/` - CMake configuration and modules. +- `scripts/` - Utility scripts for development. +- `make` - Helper script for building (wraps CMake). ## Code style - C: C99, two-space indent, no tabs. Keep functions short and focused. - Fun: two-space indent, snake_case for functions, PascalCase for classes/constructors. -- Prefer clear names over abbreviations. See [style-guide.md](./style-guide/). +- Prefer clear names over abbreviations. See [style-guide/](../style-guide/). ## Development workflow 1. Create a small, focused branch. -2. Add/adjust tests for behavior changes (see [writing-tests.md](./writing-tests/)). +2. Add/adjust tests for behavior changes (see [writing-tests](../writing-tests/)). 3. Update docs if user-visible behavior changes. 4. Submit a PR with a clear description and rationale. @@ -63,4 +62,4 @@ Please include: - `fun --version` output ## Code of Conduct -Be respectful and inclusive. See [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT/) in the repository root. +Be respectful and inclusive. See [https://git.xw3.org/fun/fun/src/branch/main/CODE_OF_CONDUCT.md](https://git.xw3.org/fun/fun/src/branch/main/CODE_OF_CONDUCT.md){:class="git"} in the repository root. diff --git a/web/documentation/documentation.md b/web/documentation/documentation.md index e9198ed..0711adc 100644 --- a/web/documentation/documentation.md +++ b/web/documentation/documentation.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Documentation @@ -10,28 +10,19 @@ description: The Fun Documentation Index permalink: /documentation/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- index +- language +- programming --- -# Fun Documentation Index This file serves as an index of the documents in this directory. Links are relative and can be opened directly on Git hosting or locally. ## Basics -- [handbook.md](./handbook.md) - Comprehensive handbook for the Fun language and VM: install/build, configuration flags, usage, and full feature overview. -- [Fun REPL Guide](./repl.md) - REPL guide: how to build/launch, editing and history, completions, REPL-on-error, and tips. +- [handbook/](./handbook/) - Comprehensive handbook for the Fun language and VM: install/build, configuration flags, usage, and full feature overview. +- [Fun REPL Guide](./repl/) - REPL guide: how to build/launch, editing and history, completions, REPL-on-error, and tips. +- [Specification v0.4](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.4.md){:class="git"} - [Specification v0.3](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.3.md){:class="git"} - [Specification v0.2](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.2.md){:class="git"} - [Specification v0.1](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.1.md){:class="git"} @@ -42,53 +33,53 @@ The examples directory contains demonstrations of most Fun features, from basic ## Overview -- [types.md](./types.md) - Core types (numbers, strings, arrays, maps, nil/bool), common operations, patterns, and interop notes. -- [numbers.md](./numbers.md) - Working with integers and floats: arithmetic, conversions, clamping, bitwise ops, and patterns. -- [strings.md](./strings.md) - Working with strings: literals/escaping, concatenation, substr/find, split, and conversions. -- [arrays.md](./arrays.md) - Working with arrays: creation, indexing/slicing, iteration patterns, helpers, and idioms. -- [maps.md](./maps.md) - Working with maps: construction, lookup/update, merging, iteration, and common patterns. -- [includes.md](./includes.md) - Using local vs. system includes, FUN_LIB_DIR, DEFAULT_LIB_DIR, and namespaced includes with `as`. -- [opcodes.md](./opcodes.md) - VM opcodes overview grouped by domain with brief behavior/stack notes. -- [internals.md](./internals.md) - Implementation details: bytecode format, VM architecture, stacks/frames, parser, and dispatch. -- [rust.md](./rust.md) - Writing Rust-backed opcodes and wiring them into the C VM; build/setup notes. -- [examples.md](./examples.md) - How to run the examples and the interactive showcase script, with environment tips. -- [testing.md](./testing.md) - How to build and run tests/targets with CMake/CTest, and where to add new tests. -- [troubleshooting.md](./troubleshooting.md) - Common issues and quick fixes for build, includes, and REPL usage. +- [types/](./types/) - Core types (numbers, strings, arrays, maps, nil/bool), common operations, patterns, and interop notes. +- [numbers/](./numbers/) - Working with integers and floats: arithmetic, conversions, clamping, bitwise ops, and patterns. +- [strings/](./strings/) - Working with strings: literals/escaping, concatenation, substr/find, split, and conversions. +- [arrays/](./arrays/) - Working with arrays: creation, indexing/slicing, iteration patterns, helpers, and idioms. +- [maps/](./maps/) - Working with maps: construction, lookup/update, merging, iteration, and common patterns. +- [includes/](./includes/) - Using local vs. system includes, FUN_LIB_DIR, DEFAULT_LIB_DIR, and namespaced includes with `as`. +- [opcodes/](./opcodes/) - VM opcodes overview grouped by domain with brief behavior/stack notes. +- [internals/](./internals/) - Implementation details: bytecode format, VM architecture, stacks/frames, parser, and dispatch. +- [rust/](./rust/) - Writing Rust-backed opcodes and wiring them into the C VM; build/setup notes. +- [examples/](./examples/) - How to run the examples and the interactive showcase script, with environment tips. +- [testing/](./testing/) - How to build and run tests/targets with CMake/CTest, and where to add new tests. +- [troubleshooting/](./troubleshooting/) - Common issues and quick fixes for build, includes, and REPL usage. ## New and supplemental guides -- [build.md](./build.md) - How to build Fun with CMake, available targets, and build options (FUN_DEBUG, FUN_USE_MUSL, FUN_WITH_CPP, FUN_WITH_RUST, FUN_WITH_OPENSSL). -- [cli.md](./cli.md) - Command-line usage of the `fun` executable: synopsis, options, exit codes, includes and library paths. -- [fun.md](./fun.md) - Full usage guide for the `fun` executable: invocation patterns, REPL, env vars, include paths, examples, and install locations. -- [asyncio.md](./asyncio.md) - Async I/O primitives and patterns: non-blocking sockets, fd polling, examples, and best practices. -- [funstx.md](./funstx.md) - Syntax checker for .fun files with optional --fix auto-corrections; usage, exit codes, and limitations. -- [contributing.md](./contributing.md) - How to contribute: project structure, coding style, running tests, and PR guidelines. -- [style-guide.md](./style-guide.md) - Coding conventions for C and Fun (indentation, naming, idioms). -- [stdlib.md](./stdlib.md) - Overview of the standard library modules under ./lib with one-line summaries. -- [embedding.md](./embedding.md) - Embedding the VM from C/Rust, lifecycle, and host integration tips. -- [errors-and-diagnostics.md](./errors-and-diagnostics.md) - Understanding parser/runtime errors and enabling diagnostics. -- [performance.md](./performance.md) - Build/runtime tuning tips and patterns for better performance. -- [security-and-sandboxing.md](./security-and-sandboxing.md) - Trust boundaries, I/O expectations, and capability restrictions. -- [faq.md](./faq.md) - Frequently asked questions and quick answers. -- [website.md](./website.md) - Documentation for the [fun-lang.xyz](https://fun-lang.xyz) website in the `./web/` directory. -- [writing-tests.md](./writing-tests.md) - How to author new tests for Fun and opcode components. -- [bytecode-format.md](./bytecode-format.md) - Reference for the bytecode format (split out from internals for convenience). -- [roadmap.md](./roadmap.md) - High-level direction, planned features, and pointers to issues. +- [build/](./build/) - How to build Fun with CMake, available targets, and build options (FUN_DEBUG, FUN_USE_MUSL, FUN_WITH_CPP, FUN_WITH_RUST, FUN_WITH_OPENSSL). +- [cli/](./cli/) - Command-line usage of the `fun` executable: synopsis, options, exit codes, includes and library paths. +- [fun/](./fun/) - Full usage guide for the `fun` executable: invocation patterns, REPL, env vars, include paths, examples, and install locations. +- [asyncio/](./asyncio/) - Async I/O primitives and patterns: non-blocking sockets, fd polling, examples, and best practices. +- [funstx/](./funstx/) - Syntax checker for .fun files with optional --fix auto-corrections; usage, exit codes, and limitations. +- [contributing/](./contributing/) - How to contribute: project structure, coding style, running tests, and PR guidelines. +- [style-guide/](./style-guide/) - Coding conventions for C and Fun (indentation, naming, idioms). +- [stdlib/](./stdlib/) - Overview of the standard library modules under ./lib with one-line summaries. +- [embedding/](./embedding/) - Embedding the VM from C/Rust, lifecycle, and host integration tips. +- [errors-and-diagnostics/](./errors-and-diagnostics/) - Understanding parser/runtime errors and enabling diagnostics. +- [performance/](./performance/) - Build/runtime tuning tips and patterns for better performance. +- [security-and-sandboxing/](./security-and-sandboxing/) - Trust boundaries, I/O expectations, and capability restrictions. +- [faq/](./faq/) - Frequently asked questions and quick answers. +- [website/](./website/) - Documentation for the [fun-lang.xyz](https://fun-lang.xyz) website in the `./web/` directory. +- [writing-tests/](./writing-tests/) - How to author new tests for Fun and opcode components. +- [bytecode-format/](./bytecode-format/) - Reference for the bytecode format (split out from internals for convenience). +- [roadmap/](./roadmap/) - High-level direction, planned features, and pointers to issues. ## Examples - - [examples/README.md](./examples/README.md) - Catalog of all example scripts under ./examples/: what each area contains, how to run them, required env vars, and extension requirements. + - [examples/README/](./examples/README/) - Catalog of all example scripts under ./examples/: what each area contains, how to run them, required env vars, and extension requirements. ## External extensions Documentation for optional, build-time selectable integrations lives in [external/](./external/): -- [Index of extensions](./external/README.md) - - Highlights: [cURL](./external/curl.md), [INI](./external/ini.md), [JSON](./external/json.md), [XML (libxml2)](./external/xml2.md), [SQLite](./external/sqlite.md), [PCRE2](./external/pcre2.md), [PC/SC](./external/pcsc.md), [OpenSSL](./external/openssl.md) +- [Index of extensions](./external/) + - Highlights: [cURL](./external/curl/), [INI](./external/ini/), [JSON](./external/json/), [XML (libxml2)](./external/xml2/), [SQLite](./external/sqlite/), [PCRE2](./external/pcre2/), [PC/SC](./external/pcsc/), [OpenSSL](./external/openssl/) ## Tips - When building from the repo without installing, set `FUN_LIB_DIR` to the local `./lib` directory so examples and the REPL can locate the stdlib. -- For a broader project overview and quickstart, see the repository root [README.md](../../README.md). +- For a broader project overview and quickstart, see the repository root [README/](../../README/). - Crypto examples: - If built with `-DFUN_WITH_OPENSSL=ON`, try `examples/crypto/openssl_md5.fun`. diff --git a/web/documentation/embedding.md b/web/documentation/embedding.md index cbcb3aa..095e866 100644 --- a/web/documentation/embedding.md +++ b/web/documentation/embedding.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Embedding Fun @@ -10,21 +10,14 @@ description: Embedding the VM from C/Rust, lifecycle, and host integration tips. permalink: /documentation/embedding/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- embedding +- host +- integration +- lifecycle +- rust +- tips --- -# Embedding Fun This guide outlines how to embed the Fun VM in a host application and extend it from C/Rust. diff --git a/web/documentation/errors-and-diagnostics.md b/web/documentation/errors-and-diagnostics.md index 064f247..ea2708e 100644 --- a/web/documentation/errors-and-diagnostics.md +++ b/web/documentation/errors-and-diagnostics.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Errors and Diagnostics @@ -10,21 +10,14 @@ description: Understanding parser/runtime errors and enabling diagnostics. permalink: /documentation/errors-and-diagnostics/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- diagnostics +- enabling +- errors +- parser +- runtime +- understanding --- -# Errors and Diagnostics This guide helps you understand common error messages and how to collect useful diagnostics. diff --git a/web/documentation/examples.md b/web/documentation/examples.md index 7f01dc5..c2e8d97 100644 --- a/web/documentation/examples.md +++ b/web/documentation/examples.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Running the Examples @@ -10,21 +10,17 @@ description: How to run the examples and the interactive showcase script, with e permalink: /documentation/examples/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- environment +- example +- examples +- interactive +- run +- running +- script +- showcase +- tips --- -# Running the Examples This page shows how to run the example programs included with the repository and how to use the interactive showcase script. diff --git a/web/documentation/examples/README.md b/web/documentation/examples/README.md index 19cc64e..0500946 100644 --- a/web/documentation/examples/README.md +++ b/web/documentation/examples/README.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Examples catalog and how to run them @@ -10,21 +10,23 @@ description: Catalog of all example scripts under ./examples/, what each area co permalink: /documentation/examples/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- area +- catalog +- contains +- env +- example +- examples +- extension +- required +- requirements +- run +- scripts +- them +- under +- vars +- what --- -# Examples catalog and how to run them This page is a practical catalog of the example areas that ship with the Fun language. It explains what you’ll find in each folder under ./examples/, how to run the scripts, and where deeper walkthroughs live. diff --git a/web/documentation/examples/builtins_extended.md b/web/documentation/examples/builtins_extended.md index ce71237..36982ac 100644 --- a/web/documentation/examples/builtins_extended.md +++ b/web/documentation/examples/builtins_extended.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - builtins_extended.fun — overview @@ -10,21 +10,10 @@ description: Documentation for builtins_extended.fun — overview permalink: /documentation/examples/builtins_extended/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- builtins_extended +- example --- -# builtins_extended.fun — overview What it shows - A tour of core built‑ins beyond the basics: printing, typing, math helpers, conversions, and utility functions commonly used in small scripts. diff --git a/web/documentation/examples/builtins_maps_and_more.md b/web/documentation/examples/builtins_maps_and_more.md index 3fad30a..daa1c72 100644 --- a/web/documentation/examples/builtins_maps_and_more.md +++ b/web/documentation/examples/builtins_maps_and_more.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - builtins_maps_and_more.fun — overview @@ -10,21 +10,10 @@ description: Documentation for builtins_maps_and_more.fun — overview permalink: /documentation/examples/builtins_maps_and_more/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- builtins_maps_and_more +- example --- -# builtins_maps_and_more.fun — overview What it shows - Exploring built‑ins while working with maps and related data structures. diff --git a/web/documentation/examples/byte_for_demo.md b/web/documentation/examples/byte_for_demo.md index 8a07647..455ba48 100644 --- a/web/documentation/examples/byte_for_demo.md +++ b/web/documentation/examples/byte_for_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - byte_for_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for byte_for_demo.fun — overview permalink: /documentation/examples/byte_for_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- byte_for_demo +- example --- -# byte_for_demo.fun — overview What it shows - Iterating bytes with a for-loop; indexing and printing byte values. diff --git a/web/documentation/examples/byte_overflow_try_catch.md b/web/documentation/examples/byte_overflow_try_catch.md index ada0410..6b72711 100644 --- a/web/documentation/examples/byte_overflow_try_catch.md +++ b/web/documentation/examples/byte_overflow_try_catch.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - byte_overflow_try_catch.fun — overview @@ -10,21 +10,10 @@ description: Documentation for byte_overflow_try_catch.fun — overview permalink: /documentation/examples/byte_overflow_try_catch/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- byte_overflow_try_catch +- example --- -# byte_overflow_try_catch.fun — overview What it shows - Error handling around byte/integer overflow using try/catch. diff --git a/web/documentation/examples/cast_demo.md b/web/documentation/examples/cast_demo.md index 9352b69..9583624 100644 --- a/web/documentation/examples/cast_demo.md +++ b/web/documentation/examples/cast_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - cast_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for cast_demo.fun — overview permalink: /documentation/examples/cast_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cast_demo +- example --- -# cast_demo.fun — overview What it shows - Conversions and casting helpers; demonstrates changing between numeric and string types safely. diff --git a/web/documentation/examples/class_constructor.md b/web/documentation/examples/class_constructor.md index 7c8de48..c6e4e9f 100644 --- a/web/documentation/examples/class_constructor.md +++ b/web/documentation/examples/class_constructor.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - class_constructor.fun — overview @@ -10,21 +10,10 @@ description: Documentation for class_constructor.fun — overview permalink: /documentation/examples/class_constructor/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- class_constructor +- example --- -# class_constructor.fun — overview What it shows - Class basics and constructor behavior; initializing fields and using methods. diff --git a/web/documentation/examples/class_test.md b/web/documentation/examples/class_test.md index 8b37d5c..1b01d26 100644 --- a/web/documentation/examples/class_test.md +++ b/web/documentation/examples/class_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - class_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for class_test.fun — overview permalink: /documentation/examples/class_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- class_test +- example --- -# class_test.fun — overview What it shows - Simple class usage and method invocation; small sanity checks around classes. diff --git a/web/documentation/examples/class_without_object.md b/web/documentation/examples/class_without_object.md index d6cb45a..1ffffbc 100644 --- a/web/documentation/examples/class_without_object.md +++ b/web/documentation/examples/class_without_object.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - class_without_object.fun — overview @@ -10,21 +10,10 @@ description: Documentation for class_without_object.fun — overview permalink: /documentation/examples/class_without_object/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- class_without_object +- example --- -# class_without_object.fun — overview What it shows - Class features that can be used without creating an instance (static-like usage patterns). diff --git a/web/documentation/examples/classes_demo.md b/web/documentation/examples/classes_demo.md index bd00e5c..5e8ec05 100644 --- a/web/documentation/examples/classes_demo.md +++ b/web/documentation/examples/classes_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - classes_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for classes_demo.fun — overview permalink: /documentation/examples/classes_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- classes_demo +- example --- -# classes_demo.fun — overview What it shows - Class basics and usage: defining classes, instantiating objects, calling methods. diff --git a/web/documentation/examples/cli_argv_dump.md b/web/documentation/examples/cli_argv_dump.md index 36b0f40..1fb48f4 100644 --- a/web/documentation/examples/cli_argv_dump.md +++ b/web/documentation/examples/cli_argv_dump.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - cli_argv_dump.fun — overview @@ -10,21 +10,10 @@ description: Documentation for cli_argv_dump.fun — overview permalink: /documentation/examples/cli_argv_dump/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cli_argv_dump +- example --- -# cli_argv_dump.fun — overview What it shows - Prints argv/argc handling to demonstrate CLI arguments parsing at a low level. diff --git a/web/documentation/examples/conversions_showcase.md b/web/documentation/examples/conversions_showcase.md index b61d08d..435741a 100644 --- a/web/documentation/examples/conversions_showcase.md +++ b/web/documentation/examples/conversions_showcase.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - conversions_showcase.fun — overview @@ -10,21 +10,10 @@ description: Documentation for conversions_showcase.fun — overview permalink: /documentation/examples/conversions_showcase/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- conversions_showcase +- example --- -# conversions_showcase.fun — overview What it shows - Numbers, strings, and bytes conversions; typical idioms and edge cases. diff --git a/web/documentation/examples/cpp_add.md b/web/documentation/examples/cpp_add.md index 31e6a83..e05f641 100644 --- a/web/documentation/examples/cpp_add.md +++ b/web/documentation/examples/cpp_add.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - cpp_add.fun — overview @@ -10,21 +10,10 @@ description: Documentation for cpp_add.fun — overview permalink: /documentation/examples/cpp_add/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cpp_add +- example --- -# cpp_add.fun — overview What it shows - Calling into the optional C++ extension from Fun. diff --git a/web/documentation/examples/data/htdocs/counter.md b/web/documentation/examples/data/htdocs/counter.md index e47aac1..3b460a0 100644 --- a/web/documentation/examples/data/htdocs/counter.md +++ b/web/documentation/examples/data/htdocs/counter.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - counter.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for counter.fun (CGI) permalink: /documentation/examples/data/htdocumentation/counter/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- counter +- example --- -# counter.fun (CGI) - Location: examples/data/htdocumentation/counter.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/data/htdocs/form_post.md b/web/documentation/examples/data/htdocs/form_post.md index d41b235..7efe6c2 100644 --- a/web/documentation/examples/data/htdocs/form_post.md +++ b/web/documentation/examples/data/htdocs/form_post.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - form_post.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for form_post.fun (CGI) permalink: /documentation/examples/data/htdocumentation/form_post/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- example +- form_post --- -# form_post.fun (CGI) - Location: examples/data/htdocumentation/form_post.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/data/htdocs/hello.md b/web/documentation/examples/data/htdocs/hello.md index fa6b3f5..dee58fb 100644 --- a/web/documentation/examples/data/htdocs/hello.md +++ b/web/documentation/examples/data/htdocs/hello.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - hello.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for hello.fun (CGI) permalink: /documentation/examples/data/htdocumentation/hello/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- example +- hello --- -# hello.fun (CGI) - Location: examples/data/htdocumentation/hello.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/data/htdocs/info.md b/web/documentation/examples/data/htdocs/info.md index 5e2f49f..0529342 100644 --- a/web/documentation/examples/data/htdocs/info.md +++ b/web/documentation/examples/data/htdocs/info.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - info.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for info.fun (CGI) permalink: /documentation/examples/data/htdocumentation/info/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- example +- info --- -# info.fun (CGI) - Location: examples/data/htdocumentation/info.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/data/htdocs/json_like_api.md b/web/documentation/examples/data/htdocs/json_like_api.md index 6bf1db4..601766c 100644 --- a/web/documentation/examples/data/htdocs/json_like_api.md +++ b/web/documentation/examples/data/htdocs/json_like_api.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - json_like_api.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for json_like_api.fun (CGI) permalink: /documentation/examples/data/htdocumentation/json_like_api/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- example +- json_like_api --- -# json_like_api.fun (CGI) - Location: examples/data/htdocumentation/json_like_api.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/data/htdocs/redirect.md b/web/documentation/examples/data/htdocs/redirect.md index 50cee04..5390697 100644 --- a/web/documentation/examples/data/htdocs/redirect.md +++ b/web/documentation/examples/data/htdocs/redirect.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - redirect.fun (CGI) @@ -10,21 +10,11 @@ description: Documentation for redirect.fun (CGI) permalink: /documentation/examples/data/htdocumentation/redirect/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cgi +- example +- redirect --- -# redirect.fun (CGI) - Location: examples/data/htdocumentation/redirect.fun - Category: CGI script used by HTTP server examples diff --git a/web/documentation/examples/datetime_basic.md b/web/documentation/examples/datetime_basic.md index ef9c26e..0c49979 100644 --- a/web/documentation/examples/datetime_basic.md +++ b/web/documentation/examples/datetime_basic.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - datetime_basic.fun — overview @@ -10,21 +10,10 @@ description: Documentation for datetime_basic.fun — overview permalink: /documentation/examples/datetime_basic/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- datetime_basic +- example --- -# datetime_basic.fun — overview What it shows - Basic time/date helpers and formatting. diff --git a/web/documentation/examples/datetime_extended.md b/web/documentation/examples/datetime_extended.md index 6a57f5f..7b38a0b 100644 --- a/web/documentation/examples/datetime_extended.md +++ b/web/documentation/examples/datetime_extended.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - datetime_extended.fun — overview @@ -10,21 +10,10 @@ description: Documentation for datetime_extended.fun — overview permalink: /documentation/examples/datetime_extended/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- datetime_extended +- example --- -# datetime_extended.fun — overview What it shows - Extended datetime helpers: parsing, arithmetic, timers, and formatting variants. diff --git a/web/documentation/examples/datetime_timer.md b/web/documentation/examples/datetime_timer.md index c072a25..d104724 100644 --- a/web/documentation/examples/datetime_timer.md +++ b/web/documentation/examples/datetime_timer.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - datetime_timer.fun — overview @@ -10,21 +10,10 @@ description: Documentation for datetime_timer.fun — overview permalink: /documentation/examples/datetime_timer/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- datetime_timer +- example --- -# datetime_timer.fun — overview What it shows - Measuring elapsed time and simple timers using datetime helpers. diff --git a/web/documentation/examples/echo_example.md b/web/documentation/examples/echo_example.md index b4c4c9a..5a23c7b 100644 --- a/web/documentation/examples/echo_example.md +++ b/web/documentation/examples/echo_example.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - echo_example.fun — overview @@ -10,21 +10,10 @@ description: Documentation for echo_example.fun — overview permalink: /documentation/examples/echo_example/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- echo_example +- example --- -# echo_example.fun — overview What it shows - Simple echo of input/args; prints back what you type or pass as arguments. diff --git a/web/documentation/examples/env_all.md b/web/documentation/examples/env_all.md index 7cafdcc..c62a3f3 100644 --- a/web/documentation/examples/env_all.md +++ b/web/documentation/examples/env_all.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - env_all.fun — overview @@ -10,21 +10,10 @@ description: Documentation for env_all.fun — overview permalink: /documentation/examples/env_all/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- env_all +- example --- -# env_all.fun — overview What it shows - Reading and listing environment variables. diff --git a/web/documentation/examples/error_handling.md b/web/documentation/examples/error_handling.md index 2113ba0..f96d482 100644 --- a/web/documentation/examples/error_handling.md +++ b/web/documentation/examples/error_handling.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - error_handling.fun — overview @@ -10,21 +10,10 @@ description: Documentation for error_handling.fun — overview permalink: /documentation/examples/error_handling/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- error_handling +- example --- -# error_handling.fun — overview What it shows - Error patterns and handling strategies using try/catch/finally. diff --git a/web/documentation/examples/expressions_test.md b/web/documentation/examples/expressions_test.md index 6dfc1c2..340e105 100644 --- a/web/documentation/examples/expressions_test.md +++ b/web/documentation/examples/expressions_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - expressions_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for expressions_test.fun — overview permalink: /documentation/examples/expressions_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- expressions_test --- -# expressions_test.fun — overview What it shows - Operator precedence and expression grouping tests/demonstrations. diff --git a/web/documentation/examples/features.md b/web/documentation/examples/features.md index 4acec72..a126b93 100644 --- a/web/documentation/examples/features.md +++ b/web/documentation/examples/features.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - features.fun — overview @@ -10,21 +10,10 @@ description: Documentation for features.fun — overview permalink: /documentation/examples/features/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- features --- -# features.fun — overview What it shows - Grab bag of language features in a single script. diff --git a/web/documentation/examples/file_print_for_file_line_by_line.md b/web/documentation/examples/file_print_for_file_line_by_line.md index 846cc91..bf9ab00 100644 --- a/web/documentation/examples/file_print_for_file_line_by_line.md +++ b/web/documentation/examples/file_print_for_file_line_by_line.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - file_print_for_file_line_by_line.fun — overview @@ -10,21 +10,10 @@ description: Documentation for file_print_for_file_line_by_line.fun — overview permalink: /documentation/examples/file_print_for_file_line_by_line/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- file_print_for_file_line_by_line --- -# file_print_for_file_line_by_line.fun — overview What it shows - Iterate a file line-by-line and print each line; basic file IO idioms. diff --git a/web/documentation/examples/floats.md b/web/documentation/examples/floats.md index f0bce67..50c1449 100644 --- a/web/documentation/examples/floats.md +++ b/web/documentation/examples/floats.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - floats.fun — overview @@ -10,21 +10,10 @@ description: Documentation for floats.fun — overview permalink: /documentation/examples/floats/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- floats --- -# floats.fun — overview What it shows - Floating point operations and formatting details. diff --git a/web/documentation/examples/for_range_test.md b/web/documentation/examples/for_range_test.md index c8b9d0e..34a9429 100644 --- a/web/documentation/examples/for_range_test.md +++ b/web/documentation/examples/for_range_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - for_range_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for for_range_test.fun — overview permalink: /documentation/examples/for_range_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- for_range_test --- -# for_range_test.fun — overview What it shows - Ranges and loops; iterating numeric ranges and verifying bounds. diff --git a/web/documentation/examples/functions_test.md b/web/documentation/examples/functions_test.md index 4c54b0c..4b39c7f 100644 --- a/web/documentation/examples/functions_test.md +++ b/web/documentation/examples/functions_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - functions_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for functions_test.fun — overview permalink: /documentation/examples/functions_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- functions_test --- -# functions_test.fun — overview What it shows - Functions, closures, and return behavior; call semantics basics. diff --git a/web/documentation/examples/have_fun.md b/web/documentation/examples/have_fun.md index 6cbe72f..0026131 100644 --- a/web/documentation/examples/have_fun.md +++ b/web/documentation/examples/have_fun.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - have_fun.fun — overview @@ -10,21 +10,10 @@ description: Documentation for have_fun.fun — overview permalink: /documentation/examples/have_fun/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- have_fun --- -# have_fun.fun — overview What it shows - Playful demo showing off small language tricks. diff --git a/web/documentation/examples/have_fun_function.md b/web/documentation/examples/have_fun_function.md index ca84216..5f65a98 100644 --- a/web/documentation/examples/have_fun_function.md +++ b/web/documentation/examples/have_fun_function.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - have_fun_function.fun — overview @@ -10,21 +10,10 @@ description: Documentation for have_fun_function.fun — overview permalink: /documentation/examples/have_fun_function/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- have_fun_function --- -# have_fun_function.fun — overview What it shows - A playful function-centric demo; small utility behaviors. diff --git a/web/documentation/examples/hex_example.md b/web/documentation/examples/hex_example.md index e53c956..d2e380a 100644 --- a/web/documentation/examples/hex_example.md +++ b/web/documentation/examples/hex_example.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - hex_example.fun — overview @@ -10,21 +10,10 @@ description: Documentation for hex_example.fun — overview permalink: /documentation/examples/hex_example/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- hex_example --- -# hex_example.fun — overview What it shows - Hex encode/decode helpers; working with hexadecimal representations. diff --git a/web/documentation/examples/if_else_test.md b/web/documentation/examples/if_else_test.md index 14de09a..5316e3c 100644 --- a/web/documentation/examples/if_else_test.md +++ b/web/documentation/examples/if_else_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - if_else_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for if_else_test.fun — overview permalink: /documentation/examples/if_else_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- if_else_test --- -# if_else_test.fun — overview What it shows - Control flow with if/else; branching and comparisons. diff --git a/web/documentation/examples/include_lib.md b/web/documentation/examples/include_lib.md index 2ab6ecc..b76f031 100644 --- a/web/documentation/examples/include_lib.md +++ b/web/documentation/examples/include_lib.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - include_lib.fun — overview @@ -10,21 +10,10 @@ description: Documentation for include_lib.fun — overview permalink: /documentation/examples/include_lib/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- include_lib --- -# include_lib.fun — overview What it shows - Including modules from the standard library path using #include <...>. diff --git a/web/documentation/examples/include_local.md b/web/documentation/examples/include_local.md index 34bd98a..413e0da 100644 --- a/web/documentation/examples/include_local.md +++ b/web/documentation/examples/include_local.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - include_local.fun — overview @@ -10,21 +10,10 @@ description: Documentation for include_local.fun — overview permalink: /documentation/examples/include_local/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- include_local --- -# include_local.fun — overview What it shows - Including local files relative to the script and reusing helpers. diff --git a/web/documentation/examples/include_local_util.md b/web/documentation/examples/include_local_util.md index 17f2f39..b359340 100644 --- a/web/documentation/examples/include_local_util.md +++ b/web/documentation/examples/include_local_util.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - include_local_util.fun — overview @@ -10,21 +10,10 @@ description: Documentation for include_local_util.fun — overview permalink: /documentation/examples/include_local_util/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- include_local_util --- -# include_local_util.fun — overview What it shows - Local include mechanics with a small utility module. diff --git a/web/documentation/examples/inheritance_demo.md b/web/documentation/examples/inheritance_demo.md index 8e7542c..3304bda 100644 --- a/web/documentation/examples/inheritance_demo.md +++ b/web/documentation/examples/inheritance_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - inheritance_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for inheritance_demo.fun — overview permalink: /documentation/examples/inheritance_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- inheritance_demo --- -# inheritance_demo.fun — overview What it shows - Simple class inheritance and method overriding examples. diff --git a/web/documentation/examples/loops_break_continue.md b/web/documentation/examples/loops_break_continue.md index 4bb542d..5fb5017 100644 --- a/web/documentation/examples/loops_break_continue.md +++ b/web/documentation/examples/loops_break_continue.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - loops_break_continue.fun — overview @@ -10,21 +10,10 @@ description: Documentation for loops_break_continue.fun — overview permalink: /documentation/examples/loops_break_continue/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- loops_break_continue --- -# loops_break_continue.fun — overview What it shows - Loop control: break and continue; demonstrating control flow within loops. diff --git a/web/documentation/examples/maps.md b/web/documentation/examples/maps.md index 4489320..e49b60d 100644 --- a/web/documentation/examples/maps.md +++ b/web/documentation/examples/maps.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - maps.fun — overview @@ -10,21 +10,17 @@ description: Working with maps, construction, lookup/update, merging, iteration, permalink: /documentation/examples/maps/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- common +- construction +- example +- iteration +- lookup +- maps +- merging +- patterns +- update --- -# maps.fun — overview What it shows - Working with maps: creation, indexing, iteration, and typical idioms. diff --git a/web/documentation/examples/match.md b/web/documentation/examples/match.md index 4001803..fc186a5 100644 --- a/web/documentation/examples/match.md +++ b/web/documentation/examples/match.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - match.fun — overview @@ -10,21 +10,10 @@ description: Documentation for match.fun — overview permalink: /documentation/examples/match/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- match --- -# match.fun — overview What it shows - Pattern matching constructs and examples of branching by value/shape. diff --git a/web/documentation/examples/namespaced_mod.md b/web/documentation/examples/namespaced_mod.md index 94a97a1..33c447c 100644 --- a/web/documentation/examples/namespaced_mod.md +++ b/web/documentation/examples/namespaced_mod.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - namespaced_mod.fun — overview @@ -10,21 +10,10 @@ description: Documentation for namespaced_mod.fun — overview permalink: /documentation/examples/namespaced_mod/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- namespaced_mod --- -# namespaced_mod.fun — overview What it shows - Namespaced includes and using the "as" aliasing pattern for modules. diff --git a/web/documentation/examples/nested_loops.md b/web/documentation/examples/nested_loops.md index 58a5f11..c8c2314 100644 --- a/web/documentation/examples/nested_loops.md +++ b/web/documentation/examples/nested_loops.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - nested_loops.fun — overview @@ -10,21 +10,10 @@ description: Documentation for nested_loops.fun — overview permalink: /documentation/examples/nested_loops/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- nested_loops --- -# nested_loops.fun — overview What it shows - Control flow with nested loops; inner/outer loop coordination. diff --git a/web/documentation/examples/net/http_mt_server.md b/web/documentation/examples/net/http_mt_server.md index 1fae357..a2537d2 100644 --- a/web/documentation/examples/net/http_mt_server.md +++ b/web/documentation/examples/net/http_mt_server.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_mt_server.fun @@ -10,21 +10,11 @@ description: Documentation for http_mt_server.fun permalink: /documentation/examples/net/http_mt_server/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_mt_server +- network --- -# http_mt_server.fun - Location: examples/net/http_mt_server.fun - Category: Networking / HTTP (multi-threaded) diff --git a/web/documentation/examples/net/http_mt_server_cgi.md b/web/documentation/examples/net/http_mt_server_cgi.md index dcd2955..ac0123b 100644 --- a/web/documentation/examples/net/http_mt_server_cgi.md +++ b/web/documentation/examples/net/http_mt_server_cgi.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_mt_server_cgi.fun @@ -10,21 +10,11 @@ description: Documentation for http_mt_server_cgi.fun permalink: /documentation/examples/net/http_mt_server_cgi/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_mt_server_cgi +- network --- -# http_mt_server_cgi.fun - Location: examples/net/http_mt_server_cgi.fun - Category: Networking / HTTP with CGI (multi-threaded) diff --git a/web/documentation/examples/net/http_server.md b/web/documentation/examples/net/http_server.md index c918d17..cf51420 100644 --- a/web/documentation/examples/net/http_server.md +++ b/web/documentation/examples/net/http_server.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_server.fun @@ -10,21 +10,11 @@ description: Documentation for http_server.fun permalink: /documentation/examples/net/http_server/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_server +- network --- -# http_server.fun - Location: examples/net/http_server.fun - Category: Networking / HTTP (blocking) diff --git a/web/documentation/examples/net/http_server_cgi.md b/web/documentation/examples/net/http_server_cgi.md index 59fb059..aad5159 100644 --- a/web/documentation/examples/net/http_server_cgi.md +++ b/web/documentation/examples/net/http_server_cgi.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_server_cgi.fun @@ -10,21 +10,11 @@ description: Documentation for http_server_cgi.fun permalink: /documentation/examples/net/http_server_cgi/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_server_cgi +- network --- -# http_server_cgi.fun - Location: examples/net/http_server_cgi.fun - Category: Networking / HTTP with CGI (blocking) diff --git a/web/documentation/examples/net/http_server_cgi_lib.md b/web/documentation/examples/net/http_server_cgi_lib.md index 98dff41..63926f5 100644 --- a/web/documentation/examples/net/http_server_cgi_lib.md +++ b/web/documentation/examples/net/http_server_cgi_lib.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_server_cgi_lib.fun @@ -10,21 +10,11 @@ description: Documentation for http_server_cgi_lib.fun permalink: /documentation/examples/net/http_server_cgi_lib/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_server_cgi_lib +- network --- -# http_server_cgi_lib.fun - Location: examples/net/http_server_cgi_lib.fun - Category: Networking / HTTP with CGI (blocking, stdlib helpers) diff --git a/web/documentation/examples/net/http_static_server.md b/web/documentation/examples/net/http_static_server.md index 3856537..c5e311d 100644 --- a/web/documentation/examples/net/http_static_server.md +++ b/web/documentation/examples/net/http_static_server.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - http_static_server.fun @@ -10,21 +10,11 @@ description: Documentation for http_static_server.fun permalink: /documentation/examples/net/http_static_server/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- http_static_server +- network --- -# http_static_server.fun - Location: examples/net/http_static_server.fun - Category: Networking / Sockets diff --git a/web/documentation/examples/net/httpserver.md b/web/documentation/examples/net/httpserver.md index 3750815..5b3ed6d 100644 --- a/web/documentation/examples/net/httpserver.md +++ b/web/documentation/examples/net/httpserver.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - HTTP server examples: architecture and how they work @@ -10,21 +10,16 @@ description: Documentation for HTTP server examples, architecture and how they w permalink: /documentation/examples/net/httpserver/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- architecture +- example +- examples +- http +- network +- server +- they +- work --- -# HTTP server examples: architecture and how they work This guide explains the HTTP server examples under `./examples/net/http_*` and the supporting standard library modules under `./lib/net/`. diff --git a/web/documentation/examples/objects_basic.md b/web/documentation/examples/objects_basic.md index c333f60..ce5b4ab 100644 --- a/web/documentation/examples/objects_basic.md +++ b/web/documentation/examples/objects_basic.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - objects_basic.fun — overview @@ -10,21 +10,10 @@ description: Documentation for objects_basic.fun — overview permalink: /documentation/examples/objects_basic/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- objects_basic --- -# objects_basic.fun — overview What it shows - OO basics: defining objects, fields, and invoking methods. diff --git a/web/documentation/examples/objects_more.md b/web/documentation/examples/objects_more.md index 43ac619..32b9e80 100644 --- a/web/documentation/examples/objects_more.md +++ b/web/documentation/examples/objects_more.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - objects_more.fun — overview @@ -10,21 +10,10 @@ description: Documentation for objects_more.fun — overview permalink: /documentation/examples/objects_more/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- objects_more --- -# objects_more.fun — overview What it shows - Additional object patterns: composition, methods, and utilities. diff --git a/web/documentation/examples/os_env.md b/web/documentation/examples/os_env.md index 978db8c..4898775 100644 --- a/web/documentation/examples/os_env.md +++ b/web/documentation/examples/os_env.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - os_env.fun — overview @@ -10,21 +10,10 @@ description: Documentation for os_env.fun — overview permalink: /documentation/examples/os_env/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- os_env --- -# os_env.fun — overview What it shows - Reading and writing environment variables from the operating system. diff --git a/web/documentation/examples/process_example.md b/web/documentation/examples/process_example.md index d266391..e81aa5a 100644 --- a/web/documentation/examples/process_example.md +++ b/web/documentation/examples/process_example.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - process_example.fun — overview @@ -10,21 +10,10 @@ description: Documentation for process_example.fun — overview permalink: /documentation/examples/process_example/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- process_example --- -# process_example.fun — overview What it shows - Spawning and capturing subprocess output; simple process management. diff --git a/web/documentation/examples/progress.md b/web/documentation/examples/progress.md index 4cc0bdb..8c50903 100644 --- a/web/documentation/examples/progress.md +++ b/web/documentation/examples/progress.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - progress.fun — overview @@ -10,21 +10,10 @@ description: Documentation for progress.fun — overview permalink: /documentation/examples/progress/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- progress --- -# progress.fun — overview What it shows - Simple progress display in the terminal. diff --git a/web/documentation/examples/progress_inline.md b/web/documentation/examples/progress_inline.md index 2eb3791..3527d7c 100644 --- a/web/documentation/examples/progress_inline.md +++ b/web/documentation/examples/progress_inline.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - progress_inline.fun — overview @@ -10,21 +10,10 @@ description: Documentation for progress_inline.fun — overview permalink: /documentation/examples/progress_inline/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- progress_inline --- -# progress_inline.fun — overview What it shows - Inline progress updates (same line updates) for simple terminal UIs. diff --git a/web/documentation/examples/random_demo.md b/web/documentation/examples/random_demo.md index e8d3bf1..b9ad7ed 100644 --- a/web/documentation/examples/random_demo.md +++ b/web/documentation/examples/random_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - random_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for random_demo.fun — overview permalink: /documentation/examples/random_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- random_demo --- -# random_demo.fun — overview What it shows - Random number generator usage and seeding basics. diff --git a/web/documentation/examples/random_number_example.md b/web/documentation/examples/random_number_example.md index 984276e..f181b9d 100644 --- a/web/documentation/examples/random_number_example.md +++ b/web/documentation/examples/random_number_example.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - random_number_example.fun — overview @@ -10,21 +10,10 @@ description: Documentation for random_number_example.fun — overview permalink: /documentation/examples/random_number_example/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- random_number_example --- -# random_number_example.fun — overview What it shows - Generating random numbers and printing them; small utility demo. diff --git a/web/documentation/examples/regex_demo.md b/web/documentation/examples/regex_demo.md index 5782c77..62e742d 100644 --- a/web/documentation/examples/regex_demo.md +++ b/web/documentation/examples/regex_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - regex_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for regex_demo.fun — overview permalink: /documentation/examples/regex_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- regex_demo --- -# regex_demo.fun — overview What it shows - Regex helpers usage; simple matching and replacement tasks. diff --git a/web/documentation/examples/regex_procedural.md b/web/documentation/examples/regex_procedural.md index 48a6407..3d5a19d 100644 --- a/web/documentation/examples/regex_procedural.md +++ b/web/documentation/examples/regex_procedural.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - regex_procedural.fun — overview @@ -10,21 +10,10 @@ description: Documentation for regex_procedural.fun — overview permalink: /documentation/examples/regex_procedural/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- regex_procedural --- -# regex_procedural.fun — overview What it shows - Procedural approach to regex work: compiling patterns and iterating matches. diff --git a/web/documentation/examples/rust_hello.md b/web/documentation/examples/rust_hello.md index 3614083..38e0774 100644 --- a/web/documentation/examples/rust_hello.md +++ b/web/documentation/examples/rust_hello.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - rust_hello.fun — overview @@ -10,21 +10,10 @@ description: Documentation for rust_hello.fun — overview permalink: /documentation/examples/rust_hello/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- rust_hello --- -# rust_hello.fun — overview What it shows - Using Rust opcodes from Fun (when built with Rust support). diff --git a/web/documentation/examples/rust_hello_args.md b/web/documentation/examples/rust_hello_args.md index 15e4c08..ebdb590 100644 --- a/web/documentation/examples/rust_hello_args.md +++ b/web/documentation/examples/rust_hello_args.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - rust_hello_args.fun — overview @@ -10,21 +10,10 @@ description: Documentation for rust_hello_args.fun — overview permalink: /documentation/examples/rust_hello_args/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- rust_hello_args --- -# rust_hello_args.fun — overview What it shows - Passing arguments into Rust-backed opcodes and handling returns. diff --git a/web/documentation/examples/rust_hello_args_return.md b/web/documentation/examples/rust_hello_args_return.md index d4f328a..2165315 100644 --- a/web/documentation/examples/rust_hello_args_return.md +++ b/web/documentation/examples/rust_hello_args_return.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - rust_hello_args_return.fun — overview @@ -10,21 +10,10 @@ description: Documentation for rust_hello_args_return.fun — overview permalink: /documentation/examples/rust_hello_args_return/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- rust_hello_args_return --- -# rust_hello_args_return.fun — overview What it shows - Demonstrates returning values from Rust-backed opcodes with arguments. diff --git a/web/documentation/examples/serial_demo.md b/web/documentation/examples/serial_demo.md index 35ac56a..90517cd 100644 --- a/web/documentation/examples/serial_demo.md +++ b/web/documentation/examples/serial_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - serial_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for serial_demo.fun — overview permalink: /documentation/examples/serial_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- serial_demo --- -# serial_demo.fun — overview What it shows - Serial port access and basic read/write (when available on your system). diff --git a/web/documentation/examples/short_circuit_test.md b/web/documentation/examples/short_circuit_test.md index 7a64125..832aa0a 100644 --- a/web/documentation/examples/short_circuit_test.md +++ b/web/documentation/examples/short_circuit_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - short_circuit_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for short_circuit_test.fun — overview permalink: /documentation/examples/short_circuit_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- short_circuit_test --- -# short_circuit_test.fun — overview What it shows - Boolean evaluation order and short-circuit behavior with && and ||. diff --git a/web/documentation/examples/signed_ints.md b/web/documentation/examples/signed_ints.md index c6bd397..b6c9154 100644 --- a/web/documentation/examples/signed_ints.md +++ b/web/documentation/examples/signed_ints.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - signed_ints.fun — overview @@ -10,21 +10,10 @@ description: Documentation for signed_ints.fun — overview permalink: /documentation/examples/signed_ints/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- signed_ints --- -# signed_ints.fun — overview What it shows - Signed integer types and operations; ranges and conversions. diff --git a/web/documentation/examples/stdlib_showcase.md b/web/documentation/examples/stdlib_showcase.md index 0485483..43e92e3 100644 --- a/web/documentation/examples/stdlib_showcase.md +++ b/web/documentation/examples/stdlib_showcase.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - stdlib_showcase.fun — overview @@ -10,21 +10,10 @@ description: Documentation for stdlib_showcase.fun — overview permalink: /documentation/examples/stdlib_showcase/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- stdlib_showcase --- -# stdlib_showcase.fun — overview What it shows - Sampler of common standard library modules and utilities. diff --git a/web/documentation/examples/strings_test.md b/web/documentation/examples/strings_test.md index 4a2ae92..03db333 100644 --- a/web/documentation/examples/strings_test.md +++ b/web/documentation/examples/strings_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - strings_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for strings_test.fun — overview permalink: /documentation/examples/strings_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- strings_test --- -# strings_test.fun — overview What it shows - String helpers and edge cases; splitting, joining, trimming, and formatting. diff --git a/web/documentation/examples/tcp_http_get.md b/web/documentation/examples/tcp_http_get.md index fd0309b..2e59828 100644 --- a/web/documentation/examples/tcp_http_get.md +++ b/web/documentation/examples/tcp_http_get.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - tcp_http_get.fun — overview @@ -10,21 +10,10 @@ description: Documentation for tcp_http_get.fun — overview permalink: /documentation/examples/tcp_http_get/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- tcp_http_get --- -# tcp_http_get.fun — overview What it shows - Manual HTTP client over raw TCP sockets: connect, write request, read response. diff --git a/web/documentation/examples/tcp_http_get_class.md b/web/documentation/examples/tcp_http_get_class.md index bad4aef..f9258d2 100644 --- a/web/documentation/examples/tcp_http_get_class.md +++ b/web/documentation/examples/tcp_http_get_class.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - tcp_http_get_class.fun — overview @@ -10,21 +10,10 @@ description: Documentation for tcp_http_get_class.fun — overview permalink: /documentation/examples/tcp_http_get_class/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- tcp_http_get_class --- -# tcp_http_get_class.fun — overview What it shows - Manual HTTP client implemented with a small helper class over sockets. diff --git a/web/documentation/examples/test_bits.md b/web/documentation/examples/test_bits.md index 22a56b4..9b51997 100644 --- a/web/documentation/examples/test_bits.md +++ b/web/documentation/examples/test_bits.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_bits.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_bits.fun — overview permalink: /documentation/examples/test_bits/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_bits --- -# test_bits.fun — overview What it shows - Bitwise utilities demonstration (and/or/xor/shifts) and small tests. diff --git a/web/documentation/examples/test_dec_to_hex.md b/web/documentation/examples/test_dec_to_hex.md index 1adb588..8abf040 100644 --- a/web/documentation/examples/test_dec_to_hex.md +++ b/web/documentation/examples/test_dec_to_hex.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_dec_to_hex.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_dec_to_hex.fun — overview permalink: /documentation/examples/test_dec_to_hex/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_dec_to_hex --- -# test_dec_to_hex.fun — overview What it shows - Decimal to hexadecimal conversion helper/tests. diff --git a/web/documentation/examples/test_hex_to_dec.md b/web/documentation/examples/test_hex_to_dec.md index 256babe..e8764e1 100644 --- a/web/documentation/examples/test_hex_to_dec.md +++ b/web/documentation/examples/test_hex_to_dec.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_hex_to_dec.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_hex_to_dec.fun — overview permalink: /documentation/examples/test_hex_to_dec/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_hex_to_dec --- -# test_hex_to_dec.fun — overview What it shows - Hexadecimal to decimal conversion helper/tests. diff --git a/web/documentation/examples/test_include.md b/web/documentation/examples/test_include.md index 9758d0f..43bab0f 100644 --- a/web/documentation/examples/test_include.md +++ b/web/documentation/examples/test_include.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_include.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_include.fun — overview permalink: /documentation/examples/test_include/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_include --- -# test_include.fun — overview What it shows - Small include mechanics test; ensures local and stdlib includes work. diff --git a/web/documentation/examples/test_rol.md b/web/documentation/examples/test_rol.md index fab84ad..00c083c 100644 --- a/web/documentation/examples/test_rol.md +++ b/web/documentation/examples/test_rol.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_rol.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_rol.fun — overview permalink: /documentation/examples/test_rol/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_rol --- -# test_rol.fun — overview What it shows - Bit rotation (ROL) helper/tests. diff --git a/web/documentation/examples/test_serial.md b/web/documentation/examples/test_serial.md index b1c842a..a77f50e 100644 --- a/web/documentation/examples/test_serial.md +++ b/web/documentation/examples/test_serial.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_serial.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_serial.fun — overview permalink: /documentation/examples/test_serial/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_serial --- -# test_serial.fun — overview What it shows - Serial port test; opens a port and exchanges a few bytes (when available). diff --git a/web/documentation/examples/test_shl.md b/web/documentation/examples/test_shl.md index 1b41dbe..748b2df 100644 --- a/web/documentation/examples/test_shl.md +++ b/web/documentation/examples/test_shl.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_shl.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_shl.fun — overview permalink: /documentation/examples/test_shl/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_shl --- -# test_shl.fun — overview What it shows - Bit shift left (SHL) helper/tests. diff --git a/web/documentation/examples/test_types.md b/web/documentation/examples/test_types.md index 7581bbc..0316cf5 100644 --- a/web/documentation/examples/test_types.md +++ b/web/documentation/examples/test_types.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_types.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_types.fun — overview permalink: /documentation/examples/test_types/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_types --- -# test_types.fun — overview What it shows - Type checks and simple assertions around type behavior. diff --git a/web/documentation/examples/test_xor.md b/web/documentation/examples/test_xor.md index 4f98a7e..3624189 100644 --- a/web/documentation/examples/test_xor.md +++ b/web/documentation/examples/test_xor.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - test_xor.fun — overview @@ -10,21 +10,10 @@ description: Documentation for test_xor.fun — overview permalink: /documentation/examples/test_xor/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- test_xor --- -# test_xor.fun — overview What it shows - Bitwise XOR helper/tests. diff --git a/web/documentation/examples/thread_class_example.md b/web/documentation/examples/thread_class_example.md index 4c89783..cfac0b0 100644 --- a/web/documentation/examples/thread_class_example.md +++ b/web/documentation/examples/thread_class_example.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - thread_class_example.fun — overview @@ -10,21 +10,10 @@ description: Documentation for thread_class_example.fun — overview permalink: /documentation/examples/thread_class_example/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- thread_class_example --- -# thread_class_example.fun — overview What it shows - Threading building blocks using a small thread class; start/join patterns. diff --git a/web/documentation/examples/threads_demo.md b/web/documentation/examples/threads_demo.md index d91d9e4..4f335b1 100644 --- a/web/documentation/examples/threads_demo.md +++ b/web/documentation/examples/threads_demo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - threads_demo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for threads_demo.fun — overview permalink: /documentation/examples/threads_demo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- threads_demo --- -# threads_demo.fun — overview What it shows - Threading building blocks and concurrent execution demo. diff --git a/web/documentation/examples/try_catch_finally.md b/web/documentation/examples/try_catch_finally.md index 2f40a5f..de632c2 100644 --- a/web/documentation/examples/try_catch_finally.md +++ b/web/documentation/examples/try_catch_finally.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - try_catch_finally.fun — overview @@ -10,21 +10,10 @@ description: Documentation for try_catch_finally.fun — overview permalink: /documentation/examples/try_catch_finally/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- try_catch_finally --- -# try_catch_finally.fun — overview What it shows - Structured error handling with try/catch/finally blocks. diff --git a/web/documentation/examples/type_safety.md b/web/documentation/examples/type_safety.md index c591ec7..2a2a18a 100644 --- a/web/documentation/examples/type_safety.md +++ b/web/documentation/examples/type_safety.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - type_safety.fun — overview @@ -10,21 +10,10 @@ description: Documentation for type_safety.fun — overview permalink: /documentation/examples/type_safety/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- type_safety --- -# type_safety.fun — overview What it shows - Static/dynamic type checks and enforcing type safety in small examples. diff --git a/web/documentation/examples/type_safety_fails.md b/web/documentation/examples/type_safety_fails.md index 6df438d..711e170 100644 --- a/web/documentation/examples/type_safety_fails.md +++ b/web/documentation/examples/type_safety_fails.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - type_safety_fails.fun — overview @@ -10,21 +10,10 @@ description: Documentation for type_safety_fails.fun — overview permalink: /documentation/examples/type_safety_fails/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- type_safety_fails --- -# type_safety_fails.fun — overview What it shows - Examples that intentionally violate type expectations to illustrate safety checks. diff --git a/web/documentation/examples/typeof.md b/web/documentation/examples/typeof.md index 7e84ea0..3d88ff2 100644 --- a/web/documentation/examples/typeof.md +++ b/web/documentation/examples/typeof.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - typeof.fun — overview @@ -10,21 +10,10 @@ description: Documentation for typeof.fun — overview permalink: /documentation/examples/typeof/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- typeof --- -# typeof.fun — overview What it shows - Type inspection using typeof and related helpers. diff --git a/web/documentation/examples/typeof_features.md b/web/documentation/examples/typeof_features.md index ed913ae..217ed90 100644 --- a/web/documentation/examples/typeof_features.md +++ b/web/documentation/examples/typeof_features.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - typeof_features.fun — overview @@ -10,21 +10,10 @@ description: Documentation for typeof_features.fun — overview permalink: /documentation/examples/typeof_features/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- typeof_features --- -# typeof_features.fun — overview What it shows - A tour of typeof-related features and type introspection helpers. diff --git a/web/documentation/examples/types_integers.md b/web/documentation/examples/types_integers.md index 0fee65d..d154d2d 100644 --- a/web/documentation/examples/types_integers.md +++ b/web/documentation/examples/types_integers.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - types_integers.fun — overview @@ -10,21 +10,10 @@ description: Documentation for types_integers.fun — overview permalink: /documentation/examples/types_integers/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- types_integers --- -# types_integers.fun — overview What it shows - Integer type families, ranges, and basic operations. diff --git a/web/documentation/examples/types_overview.md b/web/documentation/examples/types_overview.md index e721aee..63b394e 100644 --- a/web/documentation/examples/types_overview.md +++ b/web/documentation/examples/types_overview.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - types_overview.fun — overview @@ -10,21 +10,10 @@ description: Documentation for types_overview.fun — overview permalink: /documentation/examples/types_overview/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- types_overview --- -# types_overview.fun — overview What it shows - Overview of language types with small examples. diff --git a/web/documentation/examples/uint_types.md b/web/documentation/examples/uint_types.md index fb3bbbd..2d4c73f 100644 --- a/web/documentation/examples/uint_types.md +++ b/web/documentation/examples/uint_types.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - uint_types.fun — overview @@ -10,21 +10,10 @@ description: Documentation for uint_types.fun — overview permalink: /documentation/examples/uint_types/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- uint_types --- -# uint_types.fun — overview What it shows - Unsigned integer types and operations; ranges and conversions. diff --git a/web/documentation/examples/unix_socket_echo.md b/web/documentation/examples/unix_socket_echo.md index 0a48faf..afc3abd 100644 --- a/web/documentation/examples/unix_socket_echo.md +++ b/web/documentation/examples/unix_socket_echo.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - unix_socket_echo.fun — overview @@ -10,21 +10,10 @@ description: Documentation for unix_socket_echo.fun — overview permalink: /documentation/examples/unix_socket_echo/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- unix_socket_echo --- -# unix_socket_echo.fun — overview What it shows - Local domain (UNIX) socket echo server/client demonstration. diff --git a/web/documentation/examples/version.md b/web/documentation/examples/version.md index cd9fb56..86b3902 100644 --- a/web/documentation/examples/version.md +++ b/web/documentation/examples/version.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - version.fun — overview @@ -10,21 +10,10 @@ description: Documentation for version.fun — overview permalink: /documentation/examples/version/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- version --- -# version.fun — overview What it shows - Prints VM and version info for the Fun interpreter/runtime. diff --git a/web/documentation/examples/while_test.md b/web/documentation/examples/while_test.md index 6e6fb01..56a6dff 100644 --- a/web/documentation/examples/while_test.md +++ b/web/documentation/examples/while_test.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - while_test.fun — overview @@ -10,21 +10,10 @@ description: Documentation for while_test.fun — overview permalink: /documentation/examples/while_test/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- example +- while_test --- -# while_test.fun — overview What it shows - Simple while loop example; loop conditions and counters. diff --git a/web/documentation/external/curl.md b/web/documentation/external/curl.md index 4636d76..a748e53 100644 --- a/web/documentation/external/curl.md +++ b/web/documentation/external/curl.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - cURL (libcurl) extension (optional) @@ -10,21 +10,12 @@ description: Documentation for cURL (libcurl) extension (optional) permalink: /documentation/external/curl/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- curl +- extension +- libcurl +- optional --- -# cURL (libcurl) extension (optional) - CMake option: FUN_WITH_CURL=ON - Purpose: HTTP helpers using libcurl. diff --git a/web/documentation/external/README.md b/web/documentation/external/external.md similarity index 86% rename from web/documentation/external/README.md rename to web/documentation/external/external.md index 55c34a9..262b213 100644 --- a/web/documentation/external/README.md +++ b/web/documentation/external/external.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - External integrations (optional extensions) @@ -10,21 +10,27 @@ description: Catalog of all example scripts under ./examples/, what each area co permalink: /documentation/external/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- area +- catalog +- contains +- env +- example +- examples +- extension +- extensions +- external +- integrations +- optional +- required +- requirements +- run +- scripts +- them +- under +- vars +- what --- -# External integrations (optional extensions) This section documents Fun's optional, build-time selectable extensions. Each page covers: - How to enable the extension via CMake option (FUN_WITH_*) diff --git a/web/documentation/external/ini.md b/web/documentation/external/ini.md index 3376194..bc2b306 100644 --- a/web/documentation/external/ini.md +++ b/web/documentation/external/ini.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - INI (iniparser) extension (optional) @@ -10,21 +10,12 @@ description: Documentation for INI (iniparser) extension (optional) permalink: /documentation/external/ini/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- extension +- ini +- iniparser +- optional --- -# INI (iniparser) extension (optional) - CMake option: FUN_WITH_INI=ON - Purpose: Read/write simple INI configuration files. diff --git a/web/documentation/external/json.md b/web/documentation/external/json.md index 95262b7..0d2f533 100644 --- a/web/documentation/external/json.md +++ b/web/documentation/external/json.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - JSON (json-c) extension (optional) @@ -10,21 +10,11 @@ description: Documentation for JSON (json-c) extension (optional) permalink: /documentation/external/json/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- extension +- json +- optional --- -# JSON (json-c) extension (optional) - CMake option: FUN_WITH_JSON=ON - Purpose: JSON parse/stringify and file helpers via json-c. diff --git a/web/documentation/external/openssl.md b/web/documentation/external/openssl.md index 4a1d6c7..7b61237 100644 --- a/web/documentation/external/openssl.md +++ b/web/documentation/external/openssl.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - OpenSSL extension (optional) @@ -10,21 +10,11 @@ description: Documentation for OpenSSL extension (optional) permalink: /documentation/external/openssl/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- extension +- openssl +- optional --- -# OpenSSL extension (optional) - CMake option: FUN_WITH_OPENSSL=ON - Purpose: provide small crypto helpers backed by OpenSSL. Includes md5, sha256, sha512, ripemd160 helpers. diff --git a/web/documentation/external/pcre2.md b/web/documentation/external/pcre2.md index cb4c132..9218f49 100644 --- a/web/documentation/external/pcre2.md +++ b/web/documentation/external/pcre2.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - PCRE2 (Perl-Compatible Regex) extension (optional) @@ -10,21 +10,14 @@ description: Documentation for PCRE2 (Perl-Compatible Regex) extension (optional permalink: /documentation/external/pcre2/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- compatible +- extension +- optional +- pcre2 +- perl +- regex --- -# PCRE2 (Perl-Compatible Regex) extension (optional) - CMake option: FUN_WITH_PCRE2=ON - Purpose: Advanced regular expressions via PCRE2. diff --git a/web/documentation/external/pcsc.md b/web/documentation/external/pcsc.md index 5ff1de1..4a3ce6c 100644 --- a/web/documentation/external/pcsc.md +++ b/web/documentation/external/pcsc.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - PC/SC (smart cards) extension (optional) @@ -10,21 +10,12 @@ description: Documentation for PC/SC (smart cards) extension (optional) permalink: /documentation/external/pcsc/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- cards +- extension +- optional +- smart --- -# PC/SC (smart cards) extension (optional) - CMake option: FUN_WITH_PCSC=ON - Purpose: Access smart card readers/cards via PC/SC (pcsclite). diff --git a/web/documentation/external/sqlite.md b/web/documentation/external/sqlite.md index 1ac4ce7..6e634b1 100644 --- a/web/documentation/external/sqlite.md +++ b/web/documentation/external/sqlite.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - SQLite extension (optional) @@ -10,21 +10,11 @@ description: Documentation for SQLite extension (optional) permalink: /documentation/external/sqlite/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- extension +- optional +- sqlite --- -# SQLite extension (optional) - CMake option: FUN_WITH_SQLITE=ON - Purpose: Access SQLite databases via the native C API. diff --git a/web/documentation/external/xml2.md b/web/documentation/external/xml2.md index 787a98f..794d12b 100644 --- a/web/documentation/external/xml2.md +++ b/web/documentation/external/xml2.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - XML (libxml2) extension (optional) @@ -10,21 +10,12 @@ description: Documentation for XML (libxml2) extension (optional) permalink: /documentation/external/xml2/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- extension +- libxml2 +- optional +- xml --- -# XML (libxml2) extension (optional) - CMake option: FUN_WITH_XML2=ON - Purpose: Minimal XML parsing helpers using libxml2. diff --git a/web/documentation/faq.md b/web/documentation/faq.md index 5cc0aba..0e7fbf3 100644 --- a/web/documentation/faq.md +++ b/web/documentation/faq.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - FAQ @@ -10,21 +10,14 @@ description: Frequently asked questions and quick answers. permalink: /documentation/faq/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- answers +- asked +- faq +- frequently +- questions +- quick --- -# FAQ Answers to common questions. diff --git a/web/documentation/fun.md b/web/documentation/fun.md index cd356ba..677450f 100644 --- a/web/documentation/fun.md +++ b/web/documentation/fun.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun executable: full usage guide @@ -10,21 +10,19 @@ description: Full usage guide for the `fun` executable, invocation patterns, REP permalink: /documentation/fun/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- env +- examples +- executable +- full +- include +- install +- invocation +- locations +- paths +- patterns +- vars --- -# Fun executable: full usage guide This document explains how to use the `fun` binary after building or installing it: invocation patterns, options, environment variables, include/search paths, REPL, and examples. diff --git a/web/documentation/funstx.md b/web/documentation/funstx.md index 6fd2c13..e126b92 100644 --- a/web/documentation/funstx.md +++ b/web/documentation/funstx.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - funstx — Fun syntax checker and fixer @@ -10,21 +10,20 @@ description: Syntax checker for .fun files with optional --fix auto-corrections; permalink: /documentation/funstx/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- auto +- checker +- codes +- corrections +- exit +- files +- fix +- fixer +- funstx +- limitations +- optional +- syntax --- -# funstx — Fun syntax checker and fixer funstx is a small command‑line tool that parses .fun source files to verify syntax without executing them. It lives alongside the fun executable in the build directory and is installed by default. diff --git a/web/documentation/handbook.md b/web/documentation/handbook.md index 34223d3..3e4a201 100644 --- a/web/documentation/handbook.md +++ b/web/documentation/handbook.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun Handbook (Second Edition) @@ -10,21 +10,17 @@ description: Comprehensive handbook for the Fun language and VM, install/build, permalink: /documentation/handbook/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- build +- configuration +- edition +- feature +- flags +- full +- install +- language +- second --- -# Fun Handbook (Second Edition) This is a refreshed, de-duplicated, and fully up-to-date handbook for the Fun programming language and its virtual machine (VM). It keeps the same section layout as the original handbook while consolidating repeated content and documenting all currently available features, including the latest SQLite support. @@ -76,7 +72,7 @@ cd fun Configure and build (examples shown with several optional features enabled): ``` -# Every -D flag must be NAME=VALUE (e.g., -DFUN_WITH_REPL=ON) + cmake -S . -B build \ -DFUN_DEBUG=OFF \ -DFUN_WITH_REPL=ON \ @@ -147,10 +143,10 @@ SQLite support is optional and disabled by default. To build with it and run the cmake -S . -B build -DFUN_WITH_SQLITE=ON cmake --build build --target fun -# Create the sample database (requires the sqlite3 CLI): + sqlite3 ./database.sqlite < ./examples/data/database.sql -# Run the example + FUN_LIB_DIR="$(pwd)/lib" ./build/fun ./examples/sqlite_example.fun ``` @@ -162,7 +158,7 @@ XML support (via libxml2) is optional and disabled by default. To build with it cmake -S . -B build -DFUN_WITH_XML2=ON cmake --build build --target fun -# Run the example using the stdlib XML class wrapper + FUN_LIB_DIR="$(pwd)/lib" ./build/fun ./examples/xml_class_example.fun ``` diff --git a/web/documentation/includes.md b/web/documentation/includes.md index 4e94c61..2f68cb3 100644 --- a/web/documentation/includes.md +++ b/web/documentation/includes.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Includes in Fun: local vs. system and the FUN_LIB_DIR environment variable @@ -10,21 +10,16 @@ description: Using local vs. system includes, FUN_LIB_DIR, DEFAULT_LIB_DIR, and permalink: /documentation/includes/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- default_lib_dir +- environment +- fun_lib_dir +- includes +- local +- namespaced +- system +- variable --- -# Includes in Fun: local vs. system and the FUN_LIB_DIR environment variable This document explains how to use local and system includes in Fun source files and how `FUN_LIB_DIR` controls where system includes are resolved from. It also covers namespaced includes with `as`. diff --git a/web/documentation/internals.md b/web/documentation/internals.md index 8b8dcae..53ac324 100644 --- a/web/documentation/internals.md +++ b/web/documentation/internals.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun Internals @@ -10,21 +10,18 @@ description: Implementation details, bytecode format, VM architecture, stacks/fr permalink: /documentation/internals/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- architecture +- bytecode +- details +- dispatch +- format +- frames +- implementation +- internals +- parser +- stacks --- -# Fun Internals This document describes how Fun is implemented under the hood: the bytecode format, the virtual machine (VM) execution model, how opcodes are organized, error handling and debugging, and how the parser translates source code into bytecode. diff --git a/web/documentation/maps.md b/web/documentation/maps.md index 82587ab..1641154 100644 --- a/web/documentation/maps.md +++ b/web/documentation/maps.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Maps in Fun @@ -10,21 +10,16 @@ description: Working with maps, construction, lookup/update, merging, iteration, permalink: /documentation/maps/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- common +- construction +- iteration +- lookup +- maps +- merging +- patterns +- update --- -# Maps in Fun This guide focuses on maps: creation, reading/writing by key, checking key presence, iterating keys/values, nesting, and common gotchas. It complements the quick overview in types.md with a deeper, example‑driven treatment. diff --git a/web/documentation/numbers.md b/web/documentation/numbers.md index 41b0b33..bc0e52f 100644 --- a/web/documentation/numbers.md +++ b/web/documentation/numbers.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Working with numbers and floats in Fun @@ -10,21 +10,17 @@ description: Working with integers and floats, arithmetic, conversions, clamping permalink: /documentation/numbers/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- arithmetic +- bitwise +- clamping +- conversions +- floats +- integers +- numbers +- ops +- patterns --- -# Working with numbers and floats in Fun This guide covers the numeric types in Fun, with a focus on the integer "number" type and the 64‑bit floating point "float" type. You’ll find creation, arithmetic, conversion, clamping, bitwise operations, and common patterns. diff --git a/web/documentation/opcodes.md b/web/documentation/opcodes.md index 94af924..b1516ec 100644 --- a/web/documentation/opcodes.md +++ b/web/documentation/opcodes.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun VM Opcodes Overview @@ -10,21 +10,15 @@ description: VM opcodes overview grouped by domain with brief behavior/stack not permalink: /documentation/opcodes/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- behavior +- brief +- domain +- grouped +- notes +- opcodes +- stack --- -# Fun VM Opcodes Overview This document provides an overview of the available VM opcodes implemented under src/vm and its subdirectories. Opcodes are grouped by module. For each opcode, we briefly note its purpose and, where available, the expected stack arguments and return value. diff --git a/web/documentation/performance.md b/web/documentation/performance.md index 22c23f8..82ccd36 100644 --- a/web/documentation/performance.md +++ b/web/documentation/performance.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Performance Guide @@ -10,21 +10,15 @@ description: Build/runtime tuning tips and patterns for better performance. permalink: /documentation/performance/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- better +- build +- patterns +- performance +- runtime +- tips +- tuning --- -# Performance Guide Tips for getting good performance from Fun programs and builds. diff --git a/web/documentation/repl.md b/web/documentation/repl.md index 1a3dafb..e849255 100644 --- a/web/documentation/repl.md +++ b/web/documentation/repl.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun REPL Guide @@ -10,21 +10,15 @@ description: REPL guide, how to build/launch, editing and history, completions, permalink: /documentation/repl/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- build +- completions +- editing +- error +- history +- launch +- tips --- -# Fun REPL Guide This document describes the interactive Read–Eval–Print Loop (REPL) for the Fun programming language: how to build/launch it, how input and execution work, line editing and completion, the REPL buffer workflow, commands, debugging helpers, and tips. diff --git a/web/documentation/roadmap.md b/web/documentation/roadmap.md index 60a75a9..c621a3b 100644 --- a/web/documentation/roadmap.md +++ b/web/documentation/roadmap.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Roadmap @@ -10,21 +10,16 @@ description: High-level direction, planned features, and pointers to issues. permalink: /documentation/roadmap/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- direction +- features +- high +- issues +- level +- planned +- pointers +- roadmap --- -# Roadmap This page outlines high-level areas of focus and points to places where you can help. diff --git a/web/documentation/rust.md b/web/documentation/rust.md index 9781913..a308c39 100644 --- a/web/documentation/rust.md +++ b/web/documentation/rust.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Writing Rust-backed opcodes for Fun VM @@ -10,21 +10,17 @@ description: Writing Rust-backed opcodes and wiring them into the C VM; build/se permalink: /documentation/rust/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- backed +- build +- notes +- opcodes +- rust +- setup +- them +- wiring +- writing --- -# Writing Rust-backed opcodes for Fun VM This guide explains how to implement VM opcodes in Rust, wire them into the C VM, and use them from Fun scripts. diff --git a/web/documentation/security-and-sandboxing.md b/web/documentation/security-and-sandboxing.md index fa6e47b..7a0b8b5 100644 --- a/web/documentation/security-and-sandboxing.md +++ b/web/documentation/security-and-sandboxing.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Security and Sandboxing @@ -10,21 +10,15 @@ description: Trust boundaries, I/O expectations, and capability restrictions. permalink: /documentation/security-and-sandboxing/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- boundaries +- capability +- expectations +- restrictions +- sandboxing +- security +- trust --- -# Security and Sandboxing Understand the trust boundaries and how to run Fun code safely. diff --git a/web/documentation/stdlib.md b/web/documentation/stdlib.md index be2a475..2734e74 100644 --- a/web/documentation/stdlib.md +++ b/web/documentation/stdlib.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Standard Library Overview @@ -10,21 +10,16 @@ description: Overview of the standard library modules under ./lib with one-line permalink: /documentation/stdlib/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- lib +- library +- line +- modules +- one +- standard +- summaries +- under --- -# Standard Library Overview This page provides a quick orientation to the standard library located under [`./lib/`](../lib/). diff --git a/web/documentation/strings.md b/web/documentation/strings.md index acc60be..c1d28e4 100644 --- a/web/documentation/strings.md +++ b/web/documentation/strings.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Working with strings in Fun @@ -10,21 +10,16 @@ description: Working with strings, literals/escaping, concatenation, substr/find permalink: /documentation/strings/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- concatenation +- conversions +- escaping +- find +- literals +- split +- strings +- substr --- -# Working with strings in Fun This guide covers string literals, common operations (length, concatenation, substring, search, split), and interop patterns. Strings in Fun are immutable sequences of bytes/text. diff --git a/web/documentation/style-guide.md b/web/documentation/style-guide.md index 692a3f3..4f3a247 100644 --- a/web/documentation/style-guide.md +++ b/web/documentation/style-guide.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Fun Style Guide @@ -10,21 +10,14 @@ description: Coding conventions for C and Fun (indentation, naming, idioms). permalink: /documentation/style-guide/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- coding +- conventions +- idioms +- indentation +- naming +- style --- -# Fun Style Guide Conventions for writing C and Fun code in this repository. diff --git a/web/documentation/testing.md b/web/documentation/testing.md index 3e80b7f..69641a6 100644 --- a/web/documentation/testing.md +++ b/web/documentation/testing.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Building and Running Tests @@ -10,21 +10,19 @@ description: How to build and run tests/targets with CMake/CTest, and where to a permalink: /documentation/testing/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- add +- build +- building +- cmake +- ctest +- new +- run +- running +- targets +- tests +- where --- -# Building and Running Tests This page explains how to build and run Fun’s tests using the existing CMake targets. It also points to where opcode and language tests typically live and how to add new ones. diff --git a/web/documentation/troubleshooting.md b/web/documentation/troubleshooting.md index c1d0de5..4fdea05 100644 --- a/web/documentation/troubleshooting.md +++ b/web/documentation/troubleshooting.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Troubleshooting Guide @@ -10,21 +10,15 @@ description: Common issues and quick fixes for build, includes, and REPL usage. permalink: /documentation/troubleshooting/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- build +- common +- fixes +- includes +- issues +- quick +- troubleshooting --- -# Troubleshooting Guide This page lists common issues when building and running Fun from a source checkout and how to fix them quickly. diff --git a/web/documentation/types.md b/web/documentation/types.md index 2324ba0..b708b2b 100644 --- a/web/documentation/types.md +++ b/web/documentation/types.md @@ -1,39 +1,41 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false -title: Fun - Core datatypes in Fun: arrays, maps, strings, numbers, booleans and nil +title: Fun - Core datatypes, arrays, maps, strings, numbers, booleans and nil subtitle: Core types (numbers, strings, arrays, maps, nil/bool), common operations, patterns, and interop notes. description: Core types (numbers, strings, arrays, maps, nil/bool), common operations, patterns, and interop notes. permalink: /documentation/types/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- arrays +- bool +- booleans +- common +- core +- datatypes +- interop +- maps +- nil +- notes +- numbers +- operations +- patterns +- strings +- types --- -# Core datatypes in Fun: arrays, maps, strings, numbers, booleans and nil This guide shows how to create and use the most common Fun datatypes with practical examples. It focuses on arrays and maps, and also recaps numbers, floats, strings, booleans and nil so examples are self‑contained. See also: -- [arrays.md](./arrays/) — Deeper dive into array creation, indexing/slicing, iteration, and helpers. -- [strings.md](./strings/) — Practical guide to string literals, concatenation, substr/find, split, and conversions. -- [maps.md](./maps/) — Detailed guide to map construction, lookup/update, merging, and patterns. -- [numbers.md](./numbers/) — Numbers vs floats, arithmetic, conversions, clamping, bitwise ops, and common patterns. +- [arrays](../arrays/) — Deeper dive into array creation, indexing/slicing, iteration, and helpers. +- [strings](../strings/) — Practical guide to string literals, concatenation, substr/find, split, and conversions. +- [maps](../maps/) — Detailed guide to map construction, lookup/update, merging, and patterns. +- [numbers](../numbers/) — Numbers vs floats, arithmetic, conversions, clamping, bitwise ops, and common patterns. ## Quick overview diff --git a/web/documentation/website.md b/web/documentation/website.md index 03505c6..8e4d768 100644 --- a/web/documentation/website.md +++ b/web/documentation/website.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Website Documentation (fun-lang.xyz) @@ -10,21 +10,14 @@ description: Documentation for the [fun-lang.xyz](https,//fun-lang.xyz) website permalink: /documentation/website/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- directory +- https +- lang +- web +- website +- xyz --- -# Website Documentation (fun-lang.xyz) This document describes the structure and maintenance of the website for the Fun programming language, located in the `./web/` directory. The website is hosted at [https://fun-lang.xyz](https://fun-lang.xyz). diff --git a/web/documentation/writing-tests.md b/web/documentation/writing-tests.md index b8c99a4..f4a295c 100644 --- a/web/documentation/writing-tests.md +++ b/web/documentation/writing-tests.md @@ -1,7 +1,7 @@ --- layout: page published: true -noToc: true +noToc: false noComments: false noDate: false title: Fun - Writing Tests @@ -10,21 +10,14 @@ description: How to author new tests for Fun and opcode components. permalink: /documentation/writing-tests/ lang: en tags: -- documentation -- handbook -- installation -- usage -- introduction -- help -- guide -- howto -- docs -- specifications -- specs -- repl +- author +- components +- new +- opcode +- tests +- writing --- -# Writing Tests How to author tests for Fun and its opcode implementations.