Skip to content

Commit 7e5711f

Browse files
committed
Add Introduction wiki page
1 parent 36e23af commit 7e5711f

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

wiki/Introduction.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Introduction
2+
3+
`io.github.cl-sdk.wst` provides tools to help build web applications in Common Lisp.
4+
5+
The project is intended to offer practical building blocks for web development rather than forcing a single rigid application structure. It focuses on making it easier to define application behavior, organize request handling, and compose reusable web-related features.
6+
7+
## Goals
8+
9+
The main goals of the project are:
10+
11+
- provide a simple foundation for building web applications in Common Lisp
12+
- support modular application design
13+
- make common web concerns easier to manage
14+
- keep application code expressive and idiomatic
15+
16+
## What this project includes
17+
18+
Depending on how your application uses the library, the framework may help with areas such as:
19+
20+
- routing requests to handlers
21+
- session management
22+
- resilience features such as circuit breakers
23+
- organizing web application components
24+
- supporting reusable feature modules
25+
26+
## Intended audience
27+
28+
This project is intended for Common Lisp developers who want:
29+
30+
- a lightweight toolkit for web applications
31+
- reusable abstractions for server-side development
32+
- a foundation they can adapt to their own architecture
33+
34+
## How to read this wiki
35+
36+
If you are new to the project, start here and then continue with:
37+
38+
1. **Routing** for request dispatch and handler organization
39+
2. **Features** for optional or reusable application capabilities
40+
3. specific feature pages such as **Circuit breaker** and **Session**
41+
42+
## Project philosophy
43+
44+
The framework is best understood as a set of composable tools. Instead of hiding application behavior behind too much convention, it aims to expose useful primitives that developers can combine in a way that matches their application needs.
45+
46+
As you read the rest of the wiki, keep in mind that the exact integration style may vary depending on how the library is embedded in your application.

0 commit comments

Comments
 (0)