The first pre-release

Author: habedi

.gitignore

@@ -99,3 +99,4 @@ public/
 site/
 *.a
 docs/api
+static_demo/

Makefile

@@ -15,7 +15,7 @@ TEST_FLAGS := --summary all #--verbose
 JUNK_FILES := *.o *.obj *.dSYM *.dll *.so *.dylib *.a *.lib *.pdb
 
 # Automatically find all example names
-EXAMPLES      := $(patsubst %.zig,%,$(notdir $(wildcard examples/*.zig)))
+EXAMPLES      := $(shell ls $(EXAMPLES_DIR)/*.zig | sed 's|$(EXAMPLES_DIR)/||; s|\.zig$$||' | sort -V)
 EXAMPLE       ?= all
 
 SHELL         := /usr/bin/env bash
@@ -43,7 +43,7 @@ build: ## Build project (Mode=$(BUILD_TYPE))
 
 rebuild: clean build  ## clean and build
 
-run: ## Run an example (e.g. 'make run EXAMPLE=trie' or 'make run' for all)
+run: ## Run an example (like 'make run EXAMPLE=trie' or 'make run' for all)
 	@if [ "$(EXAMPLE)" = "all" ]; then \
 	   echo "--> Running all examples..."; \
 	   for ex in $(EXAMPLES); do \

README.md

@@ -9,8 +9,8 @@
 [![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/helium/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/helium/actions/workflows/tests.yml)
 [![CodeFactor](https://img.shields.io/codefactor/grade/github/CogitatorTech/helium?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/CogitatorTech/helium)
 [![Zig Version](https://img.shields.io/badge/Zig-0.15.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
-[![Docs](https://img.shields.io/github/v/tag/CogitatorTech/helium?label=docs&color=blue&style=flat&labelColor=282c34&logo=read-the-docs)](https://habedi.github.io/helium/)
-[![Examples](https://img.shields.io/github/v/tag/CogitatorTech/helium?label=examples&color=green&style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/helium/tree/main/examples)
+[![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/helium/tree/main/examples)
+[![Docs](https://img.shields.io/badge/docs-read-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://github.com/CogitatorTech/helium/tree/main/docs)
 [![Release](https://img.shields.io/github/release/CogitatorTech/helium.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/helium/releases/latest)
 [![License](https://img.shields.io/badge/license-MIT-007ec6?label=license&style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/CogitatorTech/helium/blob/main/LICENSE)
 
@@ -21,13 +21,13 @@ A micro web framework for Zig
 ---
 
 Helium is a small, configurable web framework for the Zig programming language.
-It aims to provide the essential building blocks needed for creating fast and efficient web applications and services in
+It aims to provide the essential building blocks needed for creating fast web applications and services in
 Zig without getting in the way of your application's logic.
 
 Helium follows a micro-framework design philosophy with a small core feature set that can be extended via optional
 middleware and utilities.
-It aims to be lightweight and easy to use, while still providing the necessary building blocks for building complex web
-applications by allowing users to compose their applications from reusable components.
+It aims to be lightweight and easy to use but still be able to provide the necessary building blocks for building
+complex web applications by allowing users to compose their applications from reusable components.
 
 ### Features
 
@@ -56,17 +56,11 @@ To be added.
 
 ### Documentation
 
-You can find the full API documentation for the latest release of Helium [here](https://habedi.github.io/helium/).
-
-Alternatively, you can use the `make docs` command to generate the API documentation for the current version of Helium
-from the source code.
-This will generate HTML documentation in the `docs/api` directory, which you can serve locally with `make serve-docs`
-and view in your web browser at [http://localhost:8000](http://localhost:8000).
+Check out the [docs](docs) directory for Helium documentation, including the API reference.
 
 ### Examples
 
-Check out the [examples](examples/) directory for examples of how Helium can be used to build a variety of web
-applications and services.
+Check out the [examples](examples) directory for example usages for various Helium features.
 
 ---
 

ROADMAP.md

@@ -6,8 +6,6 @@ It outlines features to be implemented and their current status.
 > [!IMPORTANT]
 > This roadmap is a work in progress and is subject to change.
 
----
-
 ### Features
 
 The following features are currently being worked on or planned for future releases.

build.zig

@@ -1,6 +1,5 @@
 const std = @import("std");
 const fs = std.fs;
-
 pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});

docs/ERROR_HANDLING.md

@@ -1,4 +1,4 @@
-## Centralized Error Handling in Helium 🛡️
+## Centralized Error Handling in Helium
 
 ### Overview
 
@@ -264,7 +264,7 @@ try doSomething(); // Errors propagate to error handler
 }
 ```
 
-### Future Enhancements
+### Future Improvements
 
 Potential future improvements to the error handling system:
 

docs/README.md

@@ -0,0 +1,3 @@
+## Helium Documentation
+
+To be added.