Basic guide directory structure

Folyd · Folyd · commit e2cdf3232447 · 2025-03-05T22:05:29.000+08:00
diff --git a/docs/_meta.json b/docs/_meta.json
@@ -6,7 +6,7 @@
   },
   {
       "text": "Reference",
-      "link": "/reference/language-syntax",
+      "link": "/reference/language-keyword",
       "activeMatch": "/reference/"
     },
     {
diff --git a/docs/guide/_meta.json b/docs/guide/_meta.json
@@ -1,17 +1,32 @@
 [
     {
-      "type": "dir",
-      "name": "getting-started",
-      "label": "Getting Started"
+        "type": "dir",
+        "name": "getting-started",
+        "label": "Getting Started"
     },
     {
-      "type": "dir",
-      "name": "language",
-      "label": "Language"
+        "type": "dir",
+        "name": "language",
+        "label": "Language"
     },
     {
-      "type": "dir",
-      "name": "web",
-      "label": "Web"
+        "type": "dir",
+        "name": "ai",
+        "label": "AI Integration"
+    },
+    {
+        "type": "dir",
+        "name": "web",
+        "label": "Web"
+    },
+    {
+        "type": "dir",
+        "name": "database",
+        "label": "Database"
+    },
+    {
+        "type": "dir",
+        "name": "auth-security",
+        "label": "Auth and Security"
     }
-  ]
+]
diff --git a/docs/guide/ai/_meta.json b/docs/guide/ai/_meta.json
@@ -0,0 +1 @@
+["prompt", "function", "agent"]
diff --git a/docs/guide/ai/agent.md b/docs/guide/ai/agent.md
@@ -0,0 +1 @@
+# Agent
diff --git a/docs/guide/ai/function.md b/docs/guide/ai/function.md
@@ -0,0 +1 @@
+# AI Function
diff --git a/docs/guide/ai/prompt.md b/docs/guide/ai/prompt.md
@@ -0,0 +1 @@
+# Prompt
diff --git a/docs/guide/auth-security/jwt.md b/docs/guide/auth-security/jwt.md
@@ -0,0 +1 @@
+# JWT Authentication
diff --git a/docs/guide/auth-security/social-login.md b/docs/guide/auth-security/social-login.md
@@ -0,0 +1 @@
+# Social Login
diff --git a/docs/guide/database/postgresql.md b/docs/guide/database/postgresql.md
@@ -0,0 +1 @@
+# PostgreSQL
diff --git a/docs/guide/database/redis.md b/docs/guide/database/redis.md
@@ -0,0 +1 @@
+# Redis
diff --git a/docs/guide/getting-started/introduction.md b/docs/guide/getting-started/introduction.md
@@ -58,24 +58,51 @@ get / {
 }
 
 $ aiscript serve web.ai
-Listening on http://localhost:8000
+Listening on http://localhost:8080
 
-$ curl http://localhost:8000
+$ curl http://localhost:8080
 {
     "error": "Missing required field: question"
 }
 
-$ curl http://localhost:8000?question=Hi
+$ curl http://localhost:8080?question=Hi
 {
     "error": "Field validation failed: question: String length is less than the minimum length of 3"
 }
 
-$ curl http://localhost:8000?question=What is the capital of France?
+$ curl http://localhost:8080?question=What is the capital of France?
 {
     "answer": "The capital of France is Paris."
 }
 ```
 
 You can open [http://localhost:8080/redoc](http://localhost:8080/redoc) to see the automatically generated API documentation.
 
-![](/guide/open-api.png)
+![](/guide/open-api.png)
+
+## Use Cases
+
+AIScript excels in these scenarios:
+
+- **AI-powered APIs**: When you need to build APIs that leverage LLMs and other AI services
+- **Prototyping**: Rapidly build and test ideas without configuration overhead
+- **Microservices**: Create lightweight, focused services with minimal boilerplate
+- **Data validation**: When request/response validation is critical to your application
+- **Internal tools**: Build tools quickly with integrated documentation
+
+## Philosophy
+
+AIScript embraces these core principles:
+
+- **Convention over configuration**: Sensible defaults that work out of the box
+- **Progressive complexity**: Easy to get started, powerful when you need it
+- **AI-native design**: Built from the ground up for the age of AI
+- **Developer happiness**: Focusing on the developer experience first
+- **Performance without sacrifice**: No need to choose between speed and productivity
+
+<!-- ## Roadmap
+
+- **Database migrations**: Integrated migration tools for schema evolution
+- **WebSocket support**: Retal-time communication capabilities
+- **Developer tools**: Enhanced debugging and profiling capabilities
+- **Edge deployment**: Deploy your AIScript apps to the edge -->
diff --git a/docs/guide/language/_meta.json b/docs/guide/language/_meta.json
@@ -0,0 +1,9 @@
+[
+    "basic",
+    "closure-lambda",
+    "pipe",
+    "enum-match",
+    "class-object",
+    "error-handling",
+    "data-validation"
+]
diff --git a/docs/guide/language/basic.md b/docs/guide/language/basic.md
@@ -1,20 +1,10 @@
 # Language Syntax
 
-## Features
-
-- Dynamic typing interpreter language
-- Auto garbage collection
-- High level and domain specific in AI and web development
-- Function is first class citizen
-- No semicolon end of line
-- Rich standard library
-- High performance, the interpreter is written in Rust
-
 ## Comments
 
 AIScript use `//` as the comment symbol.
 
-```py
+```js
 // This is a comment
 
 // A hello API endpoint
@@ -32,7 +22,7 @@ Every comment on route will be generated to the OpenAPI documentation.
 
 ## Variables
 
-```rs
+```js
 let name = "AIScript";
 let age = 18;
 ```
@@ -41,11 +31,11 @@ let age = 18;
 
 Constants are declared with the `const` keyword, and they are immutable. Constants can only be declared once and must be initialized with a value, they cannot be reassigned.
 
-```rs
+```js
 const PI = 3.14;
 ```
 
-```py
+```js
 get /hello {
     return "PI is {PI}";
 }
@@ -273,7 +263,7 @@ for i in 1..10 {
 
 ### Continue
 
-```py
+```js
 for i in 1..10 {
     if i % 2 == 0 {
         continue;
@@ -285,7 +275,7 @@ for i in 1..10 {
 
 Every type sufix with `!` is an error type. Use `raise` keyword to raise an error,
 
-```py
+```js
 fn div(a: int, b: int) -> int | DivByZero! {
     if b == 0 {
         raise DivByZero!;
diff --git a/docs/guide/language/class-object.md b/docs/guide/language/class-object.md
@@ -0,0 +1 @@
+# Class and Object
diff --git a/docs/guide/language/closure-lambda.md b/docs/guide/language/closure-lambda.md
@@ -0,0 +1 @@
+# Closure and Lambda
diff --git a/docs/guide/language/data-validation.md b/docs/guide/language/data-validation.md
@@ -0,0 +1 @@
+# Data Validation
diff --git a/docs/guide/language/enum-match.md b/docs/guide/language/enum-match.md
@@ -0,0 +1,2 @@
+# Enum and Match
+
diff --git a/docs/guide/language/error-handling.md b/docs/guide/language/error-handling.md
@@ -0,0 +1 @@
+# Error Handling
diff --git a/docs/guide/language/index.mdx b/docs/guide/language/index.mdx
diff --git a/docs/guide/language/pipe.md b/docs/guide/language/pipe.md
@@ -0,0 +1 @@
+# Pipe Operator
diff --git a/docs/guide/web/_meta.json b/docs/guide/web/_meta.json
@@ -0,0 +1,9 @@
+[
+    "route",
+    "validator",
+    "response",
+    "middleware",
+    "openapi-docs",
+    "configuration",
+    "project"
+]
diff --git a/docs/guide/web/configuration.md b/docs/guide/web/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/docs/guide/web/index.mdx b/docs/guide/web/index.mdx
diff --git a/docs/guide/web/middleware.md b/docs/guide/web/middleware.md
@@ -0,0 +1,19 @@
+# Middleware
+
+Middleware is a function that has access to the request object (req), the response object (res), and the next middleware function in the application’s request-response cycle. If you familiar web frameworks in other languages, AIScript's middleware is a similar thing.
+
+## Use builtin middlewares
+
+AIScript provides some builtin middleware, you can use them by adding them to the `middleware` section in the `project.toml` file.
+
+```toml
+# project.toml
+
+[middleware.cors]
+allowed_origins = ["http://localhost:3000"]
+allowed_methods = ["GET", "POST", "PUT", "DELETE"]
+allowed_headers = ["Content-Type", "Authorization"]
+allow_credentials = true
+```
+
+The `cors` middleware is used to enable CORS. You can also use other middleware, such as `body_limit`, `rate_limit`, `timeout`, etc. You can refer to [Middleware Configuration](../references/configuration/middleware.md) for more details.
diff --git a/docs/guide/web/openapi-docs.md b/docs/guide/web/openapi-docs.md
@@ -0,0 +1,2 @@
+# OpenAPI and Docs
+
diff --git a/docs/guide/web/project.md b/docs/guide/web/project.md
@@ -0,0 +1 @@
+# Project
diff --git a/docs/guide/web/response.md b/docs/guide/web/response.md
@@ -0,0 +1 @@
+# Response
diff --git a/docs/guide/web/route.md b/docs/guide/web/route.md
diff --git a/docs/guide/web/validator.md b/docs/guide/web/validator.md
diff --git a/docs/reference/_meta.json b/docs/reference/_meta.json

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`},`
`7`	`7`	`{`
`8`	`8`	`"text": "Reference",`
`9`		`- "link": "/reference/language-syntax",`
	`9`	`+ "link": "/reference/language-keyword",`
`10`	`10`	`"activeMatch": "/reference/"`
`11`	`11`	`},`
`12`	`12`	`{`