From 267b03d9fddbf709e542344067f0cb1694495128 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 14 Sep 2026 19:51:17 +0000 Subject: [PATCH] Fix broken links in MkDocs documentation This commit resolves strict mode `mkdocs build` failures in the CI pipeline by correcting invalid relative links and missing markdown targets across the `docs/` directory. Fixes include standardizing paths to `language/overview.md`, updating `../../examples/` from within subdirectories, and correcting capitalization issues on `installation.md`. Co-authored-by: Tcode-Motion <188012755+Tcode-Motion@users.noreply.github.com> --- docs/generics.md | 2 +- docs/getting-started/getting-started.md | 6 ++--- docs/guides/ExamplesGuide.md | 30 ++++++++++++------------- docs/index.md | 14 ++++++------ docs/language/async.md | 2 +- docs/language/concurrency.md | 2 +- docs/language/memory.md | 2 +- docs/language/packages.md | 2 +- docs/modules.md | 2 +- docs/specification/memory-model.md | 2 +- docs/tooling/package-manager.md | 2 +- 11 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/generics.md b/docs/generics.md index 5f336813..af35d238 100644 --- a/docs/generics.md +++ b/docs/generics.md @@ -53,4 +53,4 @@ do print_sound(obj: T) obj.speak() end ``` -See [Traits](traits.md) for more details. +See [Traits](language/traits.md) for more details. diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index 6c86a3f1..2326e5c7 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -5,7 +5,7 @@ This guide gets you up and running with your very first TechScript program. --- ## 💻 Prerequisite -Make sure you have installed the TechScript compiler and VM on your machine. If not, follow the [Installation Guide](Installation.md). +Make sure you have installed the TechScript compiler and VM on your machine. If not, follow the [Installation Guide](installation.md). Validate your installation: ```bash @@ -64,5 +64,5 @@ tech run age_check.txs --- ## 🎮 Explore Next -- Check out the full [Syntax Guide](syntax.md). -- Learn how to compile scripts to bytecode using [CLI docs](cli.md). +- Check out the full [Syntax Guide](../language/overview.md). +- Learn how to compile scripts to bytecode using [CLI docs](../tooling/cli.md). diff --git a/docs/guides/ExamplesGuide.md b/docs/guides/ExamplesGuide.md index 4e3bbae2..cf0f233a 100644 --- a/docs/guides/ExamplesGuide.md +++ b/docs/guides/ExamplesGuide.md @@ -32,18 +32,18 @@ tech test | Folder | Focus | Key Concept covered | |:---|:---|:---| -| [hello_world](../examples/hello_world/) | Core | Simplest output prints | -| [calculator](../examples/calculator/) | Math | Functions and math operators | -| [todo_cli](../examples/todo_cli/) | State | Lists and maps manipulation | -| [guess_number](../examples/guess_number/) | Logic | Ranges, loops, conditionals | -| [http_server](../examples/http_server/) | Network | Web routing and mock testing | -| [json_parser](../examples/json_parser/) | Data | Encoding/decoding maps | -| [file_reader](../examples/file_reader/) | File System | IO file writes and reads | -| [oop](../examples/oop/) | Models | Classes, inheritance, overriding | -| [modules](../examples/modules/) | Imports | Multi-file namespaces | -| [collections](../examples/collections/) | Types | Loops over list and maps | -| [generics](../examples/generics/) | Polymorph | Parameterized types | -| [error_handling](../examples/error_handling/) | Errors | `try`/`catch` boundaries | -| [async](../examples/async/) | Concurrency | Event loops and futures | -| [threads](../examples/threads/) | Parallel | Thread spawns & mutexes | -| [web_api](../examples/web_api/) | Fetch | External GET API calls | +| [hello_world](../../examples/hello_world/) | Core | Simplest output prints | +| [calculator](../../examples/calculator/) | Math | Functions and math operators | +| [todo_cli](../../examples/todo_cli/) | State | Lists and maps manipulation | +| [guess_number](../../examples/guess_number/) | Logic | Ranges, loops, conditionals | +| [http_server](../../examples/http_server/) | Network | Web routing and mock testing | +| [json_parser](../../examples/json_parser/) | Data | Encoding/decoding maps | +| [file_reader](../../examples/file_reader/) | File System | IO file writes and reads | +| [oop](../../examples/oop/) | Models | Classes, inheritance, overriding | +| [modules](../../examples/modules/) | Imports | Multi-file namespaces | +| [collections](../../examples/collections/) | Types | Loops over list and maps | +| [generics](../../examples/generics/) | Polymorph | Parameterized types | +| [error_handling](../../examples/error_handling/) | Errors | `try`/`catch` boundaries | +| [async](../../examples/async/) | Concurrency | Event loops and futures | +| [threads](../../examples/threads/) | Parallel | Thread spawns & mutexes | +| [web_api](../../examples/web_api/) | Fetch | External GET API calls | diff --git a/docs/index.md b/docs/index.md index be8febc0..8b7ff294 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,11 +7,11 @@ Welcome to the TechScript official documentation! TechScript is an open-source, ## 🗺️ Documentation Portal Reference ### 🚀 Getting Started -* [Installation](Installation.md) - Set up TechScript on Windows, Linux, macOS, or Build from Source. -* [Language Guide](LanguageGuide.md) - Learn variables, loops, conditionals, and functions. +* [Installation](getting-started/installation.md) - Set up TechScript on Windows, Linux, macOS, or Build from Source. +* [Language Guide](language/overview.md) - Learn variables, loops, conditionals, and functions. * [Syntax Guide](SyntaxGuide.md) - Quick reference on keywords, precedence, and layout rules. -* [Best Practices](BestPractices.md) - Coding standards, constants, and safety. -* [FAQ](FAQ.md) - Common questions and answers. +* [Best Practices](guides/BestPractices.md) - Coding standards, constants, and safety. +* [FAQ](faq.md) - Common questions and answers. ### 🧱 Declarative Submodules * [DSL Guide](DSLGuide.md) - Domain-specific UI block specifications. @@ -19,8 +19,8 @@ Welcome to the TechScript official documentation! TechScript is an open-source, * [Web Guide](WebGuide.md) - Full-stack site generation via `use web`. ### ⚡ Compiler & Engine Specification -* [Compiler Architecture](CompilerArchitecture.md) - Analysis of lexer, Pratt parser, and LLVM backend. -* [VM Specification](vm.md) - Details on stack execution, frame layouts, and NaN-boxing. +* [Compiler Architecture](compiler/architecture.md) - Analysis of lexer, Pratt parser, and LLVM backend. +* [VM Specification](compiler/vm.md) - Details on stack execution, frame layouts, and NaN-boxing. * [Performance benchmarks](Performance.md) - Speed comparison data and optimization rules. ### 🤝 Project, Release & Community @@ -29,5 +29,5 @@ Welcome to the TechScript official documentation! TechScript is an open-source, * [Supported Versions](SUPPORTED_VERSIONS.md) - Support lifetimes and version tracking. * [Security Policy](Security.md) - Reporting vulnerability channels. * [Migration Guide](MigrationGuide.md) - Code migration from v1.0.8 legacy aliases. -* [Examples Guide](ExamplesGuide.md) - Running and checking code examples. +* [Examples Guide](guides/ExamplesGuide.md) - Running and checking code examples. * [Release Notes](ReleaseNotes.md) - Version release history details. diff --git a/docs/language/async.md b/docs/language/async.md index 4b9de54d..02ffe6b5 100644 --- a/docs/language/async.md +++ b/docs/language/async.md @@ -46,4 +46,4 @@ end await main() ``` -For true parallelism utilizing CPU cores, see [Multithreading Guide](multithreading.md). +For true parallelism utilizing CPU cores, see [Multithreading Guide](concurrency.md). diff --git a/docs/language/concurrency.md b/docs/language/concurrency.md index a770d93a..dcb8d790 100644 --- a/docs/language/concurrency.md +++ b/docs/language/concurrency.md @@ -57,4 +57,4 @@ parallel sync.unlock(counter) end ``` -See [Memory Model](memory-model.md) for data transfer rules. +See [Memory Model](../specification/memory-model.md) for data transfer rules. diff --git a/docs/language/memory.md b/docs/language/memory.md index 58e1098c..cb258f68 100644 --- a/docs/language/memory.md +++ b/docs/language/memory.md @@ -44,4 +44,4 @@ say list_a # prints [1, 2] (remains unaffected) ## 🔁 Variable Lifecycles When a scope exits, all variable references inside that scope are dropped. If an object's total reference count drops to zero, its heap memory is immediately reclaimed by the VM allocator. -See [Memory Model](memory-model.md) for Garbage Collector mechanics. +See [Memory Model](../specification/memory-model.md) for Garbage Collector mechanics. diff --git a/docs/language/packages.md b/docs/language/packages.md index e9d18122..51d0d623 100644 --- a/docs/language/packages.md +++ b/docs/language/packages.md @@ -37,4 +37,4 @@ my_package/ ``` The entry point of the package is always `src/index.txs`. When another project depends on this package, importing `use my_package` loads the definitions from `src/index.txs`. -For details about managing packages, see the [Package Manager Guide](package-manager.md). +For details about managing packages, see the [Package Manager Guide](../tooling/package-manager.md). diff --git a/docs/modules.md b/docs/modules.md index 5a50e946..8e560378 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -46,4 +46,4 @@ use trig ``` Now, `main.txs` can access everything inside via `use math_helpers`. -For imports details, see [Imports Guide](imports.md). +For imports details, see [Imports Guide](language/imports-exports.md). diff --git a/docs/specification/memory-model.md b/docs/specification/memory-model.md index 8aab413e..6ae5e36c 100644 --- a/docs/specification/memory-model.md +++ b/docs/specification/memory-model.md @@ -22,4 +22,4 @@ TechScript inherits its memory safety guarantees from its Rust runtime core: Objects on the heap are tracked and freed using Automatic Reference Counting (ARC) backed by a cycle-detecting mark-and-sweep Garbage Collector (GC). * **Reference Counting**: Objects are deleted immediately when their reference count drops to zero. * **Cycle Detector**: Periodically runs in the background to identify and clean up cyclic reference structures (e.g. object A referencing B, which references A). -See [Ownership Guide](ownership.md) for data lifecycle details. +See [Ownership Guide](../language/memory.md) for data lifecycle details. diff --git a/docs/tooling/package-manager.md b/docs/tooling/package-manager.md index a2ca3400..10980f57 100644 --- a/docs/tooling/package-manager.md +++ b/docs/tooling/package-manager.md @@ -42,4 +42,4 @@ All downloaded packages are stored globally in a central cache directory: * **Linux/macOS**: `~/.techscript/cache` During compilation, the compiler resolves imports by checking the local cache first before searching internet sources. -See [Packages Guide](packages.md) for details on metadata. +See [Packages Guide](../language/packages.md) for details on metadata.