chore: sync docs from jaseci-labs/jaseci (#489)

Automated sync of documentation from jaseci-labs/jaseci repository.
- Updated jac-gpt-fullstack/services/docs with latest markdown files
- Regenerated all_section_links.json with semantic embeddings
Updated on: 2026-02-16 00:21:15 UTC

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: github-actions[bot]

jac-gpt-fullstack/services/docs/community/breaking-changes.md

@@ -6,6 +6,102 @@ This page documents significant breaking changes in Jac and Jaseci that may affe
 
 MTLLM library is now deprecated and replaced by the byLLM package. In all place where `mtllm` was used before can be replaced with `byllm`.
 
+### Test Syntax Changed from Identifiers to String Descriptions
+
+The `test` keyword now requires a **string description** instead of an identifier name. This gives tests more readable, natural-language names with spaces, punctuation, and proper casing.
+
+**Before:**
+
+```jac
+test my_calculator_add {
+    calc = Calculator();
+    assert calc.add(5) == 5;
+}
+
+test walker_visits_all_nodes {
+    root spawn MyWalker();
+    assert visited_count == 3;
+}
+```
+
+**After:**
+
+```jac
+test "my calculator add" {
+    calc = Calculator();
+    assert calc.add(5) == 5;
+}
+
+test "walker visits all nodes" {
+    root spawn MyWalker();
+    assert visited_count == 3;
+}
+```
+
+**Key Changes:**
+
+- Test names must be quoted strings: `test "description" { ... }` instead of `test name { ... }`
+- Spaces, punctuation, and mixed case are now allowed in test names
+- The string description is displayed as-is in test output (pytest, `jac test`)
+- A valid Python identifier is derived automatically for internal use (lowercased, non-alphanumeric replaced with `_`)
+
+**Migration:** Replace `test identifier_name {` with `test "identifier name" {` in all `.jac` files (convert underscores to spaces).
+
+### CLI Dependency Commands Redesigned (0.10.0)
+
+The `jac add`, `jac install`, `jac remove`, and `jac update` commands were redesigned. Key behavioral changes:
+
+- `jac add` now **requires** at least one package argument (previously, calling `jac add` with no args silently fell through to install)
+- `jac add` without a version spec now queries the installed version and records `~=X.Y` (previously recorded `>=0.0.0`)
+- `jac install` now syncs all dependency types (pip, git, and plugin-provided like npm)
+- New `jac update` command for updating dependencies to latest compatible versions
+- Virtual environment is now at `.jac/venv/` instead of `.jac/packages/`
+
+### KWESC_NAME Syntax Changed from `<>` to Backtick
+
+Keyword-escaped names now use a backtick (`` ` ``) prefix instead of the angle-bracket (`<>`) prefix. This affects any identifier that uses a Jac keyword as a variable, field, or parameter name.
+
+**Before:**
+
+```jac
+glob <>node = 10;
+glob <>walker = 30;
+
+obj Foo {
+    has <>type: str = "default";
+}
+
+myobj = otherobj.<>walker.<>type;
+```
+
+**After:**
+
+```jac
+glob `node = 10;
+glob `walker = 30;
+
+obj Foo {
+    has `type: str = "default";
+}
+
+myobj = otherobj.`walker.`type;
+```
+
+**Note:** Builtin type names (`list`, `dict`, `set`, `tuple`, `any`, `type`, `bytes`, `int`, `float`, `str`, `bool`) do **not** need backtick escaping when used in expression contexts (function calls, type annotations, isinstance arguments). Backtick is only needed when using them as field, variable, or parameter names:
+
+```jac
+# No backtick needed (expression context)
+x = list(items);
+y: tuple[(int, int)] = (1, 2);
+if isinstance(val, dict) { ... }
+
+# Backtick needed (identifier context)
+has `type: str = "default";
+`bytes = read_data();
+```
+
+**Migration:** Find and replace all `<>` keyword escape prefixes with `` ` `` in your `.jac` files.
+
 ### Backtick Type Operator Removed
 
 The backtick (`` ` ``) type operator (`TYPE_OP`) and `TypeRef` AST node have been removed from the language. This affects two areas: walker event signatures and filter comprehensions.
@@ -170,7 +266,7 @@ walker AddTodo { has title: str; }
 ```jac
 # main.cl.jac - auto-annexed to main.jac (no explicit import needed)
 cl {
-    def:pub app -> any {
+    def:pub app -> JsxElement {
         return <div>Hello World</div>;
     }
 }
@@ -188,15 +284,15 @@ walker AddTodo { has title: str; }
 cl {
     import from .frontend { app as ClientApp }
 
-    def:pub app -> any {
+    def:pub app -> JsxElement {
         return <ClientApp />;
     }
 }
 ```
 
 ```jac
 # frontend.cl.jac - standalone client module (renamed from main.cl.jac)
-def:pub app -> any {
+def:pub app -> JsxElement {
     return <div>Hello World</div>;
 }
 ```
@@ -217,7 +313,7 @@ def:pub app -> any {
    cl {
        import from .frontend { app as ClientApp }
 
-       def:pub app -> any {
+       def:pub app -> JsxElement {
            return <ClientApp />;
        }
    }
@@ -230,7 +326,7 @@ def:pub app -> any {
    walker AddTodo { has title: str; }  # Stub for RPC calls
    walker ListTodos {}
 
-   def:pub app -> any { ... }
+   def:pub app -> JsxElement { ... }
    ```
 
 **Note:** `.cl.jac` files can still have their own `.impl.jac` annexes for separating declarations from implementations.
@@ -495,22 +591,22 @@ The `check` keyword has been removed from Jaclang. All testing functionality is
 glob a: int = 5;
 glob b: int = 2;
 
-test test_equality {
+test "equality" {
     check a == 5;
     check b == 2;
 }
 
-test test_comparison {
+test "comparison" {
     check a > b;
     check a - b == 3;
 }
 
-test test_membership {
+test "membership" {
     check "a" in "abc";
     check "d" not in "abc";
 }
 
-test test_function_result {
+test "function result" {
     check almostEqual(a + b, 7);
 }
 ```
@@ -521,22 +617,22 @@ test test_function_result {
 glob a: int = 5;
 glob b: int = 2;
 
-test test_equality {
+test "equality" {
     assert a == 5;
     assert b == 2;
 }
 
-test test_comparison {
+test "comparison" {
     assert a > b;
     assert a - b == 3;
 }
 
-test test_membership {
+test "membership" {
     assert "a" in "abc";
     assert "d" not in "abc";
 }
 
-test test_function_result {
+test "function result" {
     assert almostEqual(a + b, 7);
 }
 ```

jac-gpt-fullstack/services/docs/community/internals/jsx_client_serv_design.md

@@ -607,7 +607,7 @@ HTML template (from [server.py:491-504](https://github.com/Jaseci-Labs/jaseci/bl
     <script id="__jac_init__" type="application/json">
         {"module":"myapp","function":"homepage","args":{},"globals":{},"argOrder":[]}
     </script>
-    <script src="/static/client.js?hash=abc123..." defer></script>
+    <script type="module" src="/static/client.js?hash=abc123..."></script>
 </body>
 </html>
 ```

jac-gpt-fullstack/services/docs/community/release_notes/byllm.md

@@ -2,9 +2,19 @@
 
 This document provides a summary of new features, improvements, and bug fixes in each version of **byLLM** (formerly MTLLM). For details on changes that might require updates to your existing code, please refer to the [Breaking Changes](../breaking-changes.md) page.
 
-## byllm 0.4.18 (Unreleased)
+## byllm 0.4.20 (Unreleased)
 
-## byllm 0.4.17 (Latest Release)
+- Minor internal refactors
+
+## byllm 0.4.19 (Latest Release)
+
+- Various refactors
+- **Fix: `api_key` parameter no longer silently ignored**: The `api_key` passed via constructor, instance config, or global config (`jac.toml`) was being overwritten with `None` before every LLM call. The key is now properly resolved with a clear priority chain (constructor > instance config > global config > environment variables) and passed to LiteLLM, OpenAI client, and HTTP calls. API keys are also masked in verbose logs, showing only the last 4 characters.
+- **Fix: MTIR scope key mismatch between compile-time and runtime**: Fixed a bug where MTIR entries stored at compile-time could not be retrieved at runtime due to mismatched scope keys. At compile-time, the scope key was generated using the module's file path, while at runtime it used `__main__`. This caused `by llm()` calls to silently fall back to introspection mode, losing all `sem` string descriptions. The fix uses `sys.modules['__main__'].__file__` at runtime to get the entry point's file path, then extracts the file stem to match the compile-time scope key format.
+
+## byllm 0.4.18
+
+## byllm 0.4.17
 
 - **Enum Semantic Strings in Schema**: Added support for extracting semantic strings from enum members at compile time. Enum member descriptions (e.g., `sem Personality.INTROVERT = "Person who is reserved..."`) are now included in LLM schemas, providing richer context for enum selection.
 

jac-gpt-fullstack/services/docs/community/release_notes/jac-client.md

@@ -2,15 +2,38 @@
 
 This document provides a summary of new features, improvements, and bug fixes in each version of **Jac-Client**. For details on changes that might require updates to your existing code, please refer to the [Breaking Changes](../breaking-changes.md) page.
 
-## jac-client 0.2.16 (Unreleased)
+## jac-client 0.2.18 (Unreleased)
 
+- 2 Minor internal refactors
+
+## jac-client 0.2.17 (Latest Release)
+
+- **Structured Build Error Diagnostics**: Build errors now display formatted diagnostic output with error codes (JAC_CLIENT_XXX), source code snippets pointing to the error location, actionable hints, and quick fix commands. The diagnostic engine maps Vite/npm errors back to original `.jac` files, hiding internal JavaScript paths from developers. Detectors identify common issues: missing npm dependencies (JAC_CLIENT_001), syntax errors (JAC_CLIENT_003), and unresolved imports (JAC_CLIENT_004). Enable `debug = true` under `[plugins.client]` in `jac.toml` or set `JAC_DEBUG=1` to see raw error output alongside formatted diagnostics.
+
+- Various refactors
+- **Improved `jac start` Output Ordering**: Fixed misleading output timing where "Server ready" and localhost URLs appeared before compilation completed. The Vite dev server now captures its initial output and waits for the ready signal before displaying status messages, ensuring users see compilation progress first and server URLs only when the server is actually ready to accept connections.
+- **PWA Target Support**: Added a new `pwa` target for creating Progressive Web Apps. Run `jac setup pwa` to configure your project with PWA support-this copies default icons to `pwa_icons/` and adds the `[plugins.client.pwa]` config section to `jac.toml`. Then use `jac build --client pwa` to build or `jac start --client pwa` to build and serve. The build generates a web bundle with `manifest.json`, a service worker (`sw.js`) for offline caching, and automatic HTML injection. The service worker implements cache-first for static assets and network-first for API calls (`/api/*`). Configure `theme_color`, `background_color`, `cache_name`, and custom `manifest` overrides in `[plugins.client.pwa]`.
+- **Code refactors**: Backtick escape, etc.
+- **Environment Variable Support**: Fixed `.env` file loading by configuring Vite's `envDir` to point to the project root instead of the build directory. Variables prefixed with `VITE_` in `.env` files are now properly loaded and available via `import.meta.env` in client code. Added `.env.example` template to the all-in-one example demonstrating standard environment variable patterns.
+- **Build-time Constants via jac.toml**: Added support for custom build-time constants through the `[plugins.client.vite.define]` configuration section. Define global variables that are replaced at build time, useful for feature flags, build timestamps, or configuration values. Example: `"globalThis.FEATURE_ENABLED" = true` in `jac.toml` makes `globalThis.FEATURE_ENABLED` available in client code. String values are automatically JSON-escaped to handle special characters safely.
+- Updated all-in-one example `jac.toml` to include `[plugins.scale.secrets]` test config.
+- **Improved API Error Handling**: Walker and function API calls now check `response.ok` and throw descriptive exceptions on HTTP errors. The `Authorization` header is only sent when a token is present, avoiding empty `Bearer` headers.
+- **Better Error Diagnostics**: Silent `except Exception {}` blocks in `jacLogin` and `__jacCallFunction` now log warnings via `console.warn` for easier debugging.
+- Docs update: return type `any` -> `JsxElement`
+
+## jac-client 0.2.16
+
+ **Fix: ESM Script Loading**: Added `type="module"` to generated `<script>` tags in the client HTML output. The Vite bundler already produces ES module output, but the script tags were missing the module attribute, causing browsers to reject ESM syntax (e.g., `import`/`export`) from newer npm packages. Affects both the server-rendered page and the `jac build --target web` static output.
+
+- **KWESC_NAME syntax changed from `<>` to backtick**: Updated keyword-escaped names from `<>` prefix to backtick prefix to match the jaclang grammar change.
 - **Update syntax for TYPE_OP removal**: Replaced backtick type operator syntax (`` `root ``) with `Root` and filter syntax (`` (`?Type) ``) with `(?:Type)` across all examples, docs, tests, and templates.
 - **Support custom Vite Configurations to `dev` mode**: Added support for custom Vite configuration from `jac.toml`.
 - **Watchdog auto-install test**: Added test coverage for automatic watchdog installation in dev mode.
+- **Updated tests for CLI dependency command redesign**: New `jac add` behavior (errors on missing `jac.toml` instead of silently succeeding). Verify `jac add --npm` works in projects with both pypi and npm dependencies.
 
-## jac-client 0.2.14 (Latest Release)
+## jac-client 0.2.14
 
-## jac-client 0.2.15 (Latest Release)
+## jac-client 0.2.15
 
 ## jac-client 0.2.14
 

jac-gpt-fullstack/services/docs/community/release_notes/jac-scale.md

@@ -2,11 +2,34 @@
 
 This document provides a summary of new features, improvements, and bug fixes in each version of **Jac-Scale**. For details on changes that might require updates to your existing code, please refer to the [Breaking Changes](../breaking-changes.md) page.
 
-## jac-scale 0.1.7 (Unreleased)
-
+## jac-scale 0.1.9 (Unreleased)
+
+- 1 Minor refactors/changes.
+
+## jac-scale 0.1.8 (Latest Release)
+
+- Internal: K8s integration tests now install jac plugins from fork PRs instead of always using main
+- **.jac folder is excluded when creating the zip folder that is uploaded into jaseci deployment pods.Fasten up deployment**
+- **Fix: `jac start` Startup Banner**: Server now displays the startup banner (URLs, network IPs, mode info) correctly via `on_ready` callback, consistent with stdlib server behavior.
+- Various refactors
+- **PWA Build Detection**: Server startup now detects existing PWA builds (via `manifest.json`) and skips redundant client bundling. The `/static/client.js` endpoint serves Vite-hashed files (`client.*.js`) in PWA mode.
+- **Prometheus Metrics Integration**: Added `/metrics` endpoint with HTTP request metrics, configurable via `[plugins.scale.metrics]` in `jac.toml`.
+- Update jaseci scale k8s pipeline to support parellel test cases.
+- **early exit from k8s deployment if container restarted**
+- **Direct Database Access (`kvstore`)**: Added `kvstore()` function for direct MongoDB and Redis operations without graph layer. Supports database-specific methods (MongoDB: `find_one`, `insert_one`, `update_one`; Redis: `set_with_ttl`, `incr`, `scan_keys`) with common methods (`get`, `set`, `delete`, `exists`) working across both. Import from `jac_scale.lib` with URI-based connection pooling and configuration fallback (explicit URI → env vars → jac.toml).
+- **Code refactors**: Backtick escape, etc.
+- **Native Kubernetes Secret support**: New `[plugins.scale.secrets]` config section. Declare secrets with `${ENV_VAR}` syntax, auto-resolved at deploy time into a K8s Secret with `envFrom.secretRef`.
+- **Minor Internal Refactor in Tests**: Minor internal refactoring in test_direct.py to improve test structure
+- **fix**: Return 401 instead of 500 for deleted users with valid JWT tokens.
+- Docs update: return type `any` -> `JsxElement`
+- **1 Small Refactors**
+
+## jac-scale 0.1.7
+
+- **KWESC_NAME syntax changed from `<>` to backtick**: Updated keyword-escaped names from `<>` prefix to backtick prefix to match the jaclang grammar change.
 - **Update syntax for TYPE_OP removal**: Replaced backtick type operator syntax (`` `root ``) with `Root` and filter syntax (`` (`?Type) ``) with `(?:Type)` across all docs, tests, examples, and README.
 
-## jac-scale 0.1.6 (Latest Release)
+## jac-scale 0.1.6
 
 - **WebSocket Support**: Added WebSocket transport for walkers via `@restspec(protocol=APIProtocol.WEBSOCKET)` with persistent bidirectional connections at `ws://host/ws/{walker_name}`. The `APIProtocol` enum (`HTTP`, `WEBHOOK`, `WEBSOCKET`) replaces the previous `webhook=True` flag-migrate by changing `@restspec(webhook=True)` to `@restspec(protocol=APIProtocol.WEBHOOK)`.
 
@@ -94,12 +117,13 @@ First release of **Jac-Scale** - a scalable runtime framework for distributed Ja
 
 ### Key Features
 
-- Distributed runtime with load balancing and service discovery
-- Intelligent walker scheduling across multiple nodes
-- Auto-partitioned graph storage
-- Performance monitoring and auto-scaling
-- YAML-based configuration
-- Username-based user management for authentication
+- Conversion of walker to fastapi endpoints
+- Multi memory hierachy implementation
+- Support for Mongodb (persistance storage) and Redis (cache storage) in k8s
+- Deployment of app code directly to k8s cluster
+- k8s support for local deployment and aws k8s deployment
+- SSO support for google
+
 - **Custom Response Headers**: Configure custom HTTP response headers via `[environments.response.headers]` in `jac.toml`. Useful for security headers like COOP/COEP (required for `SharedArrayBuffer` support in libraries like monaco-editor).
 
 ### Installation

jac-gpt-fullstack/services/docs/community/release_notes/jac-super.md

@@ -2,9 +2,17 @@
 
 This document provides a summary of new features, improvements, and bug fixes in each version of **Jac-Super**. For details on changes that might require updates to your existing code, please refer to the [Breaking Changes](../breaking-changes.md) page.
 
-## jac-super 0.1.1 (Unreleased)
+## jac-super 0.1.3 (Unreleased)
 
-## jac-super 0.1.0 (Latest Release)
+## jac-super 0.1.2 (Latest Release)
+
+- Various refactors
+
+## jac-super 0.1.1
+
+- **KWESC_NAME syntax changed from `<>` to backtick**: Updated keyword-escaped names from `<>` prefix to backtick prefix to match the jaclang grammar change.
+
+## jac-super 0.1.0
 
 - **Rich-Enhanced Console Output**: Introduced `jac-super` as a plugin that provides elegant, colorful terminal output for Jac CLI commands. The plugin overrides the base console implementation to add Rich-based formatting with:
   - **Themed Output**: Custom color themes for success (green), error (red), warning (yellow), and info (cyan) messages