Unifying syntax styling (#66)

reynaldichernando · web-flow · commit a6ccedda7649 · 2025-11-07T09:01:31.000+07:00
* Fix ai syntaxes

* Fix apps syntax

* Fix auth syntax

* Fix fs syntax

* Fix syntax workers

* Fix syntax hosting

* Fix syntax kv

* Fix syntax ui

* Fix syntax utils
diff --git a/src/AI/chat.md b/src/AI/chat.md
@@ -9,12 +9,12 @@ Given a prompt returns the completion that best matches the prompt.
 ## Syntax
 
 ```js
-puter.ai.chat(prompt);
-puter.ai.chat(prompt, (options = {}));
-puter.ai.chat(prompt, (testMode = false), (options = {}));
-puter.ai.chat(prompt, imageURL, (testMode = false), (options = {}));
-puter.ai.chat(prompt, [imageURLArray], (testMode = false), (options = {}));
-puter.ai.chat([messages], (testMode = false), (options = {}));
+puter.ai.chat(prompt)
+puter.ai.chat(prompt, options = {})
+puter.ai.chat(prompt, testMode = false, options = {})
+puter.ai.chat(prompt, imageURL, testMode = false, options = {})
+puter.ai.chat(prompt, [imageURLArray], testMode = false, options = {})
+puter.ai.chat([messages], testMode = false, options = {})
 ```
 
 ## Parameters
diff --git a/src/AI/img2txt.md b/src/AI/img2txt.md
@@ -9,7 +9,7 @@ Given an image will return the text contained in the image. Also known as OCR (O
 ## Syntax
 
 ```js
-puter.ai.img2txt(image, (testMode = false));
+puter.ai.img2txt(image, testMode = false)
 ```
 
 ## Parameters
diff --git a/src/AI/txt2img.md b/src/AI/txt2img.md
@@ -9,8 +9,8 @@ Given a prompt, generate an image using AI.
 ## Syntax
 
 ```js
-puter.ai.txt2img(prompt, (testMode = false))
-puter.ai.txt2img(prompt, (options = {}))
+puter.ai.txt2img(prompt, testMode = false)
+puter.ai.txt2img(prompt, options = {})
 ```
 
 ## Parameters
diff --git a/src/Apps/create.md b/src/Apps/create.md
@@ -9,10 +9,10 @@ Creates a Puter app with the given name. The app will be created in the user's a
 ## Syntax
 
 ```js
-puter.apps.create(name, indexURL);
-puter.apps.create(name, indexURL, title);
-puter.apps.create(name, indexURL, title, description);
-puter.apps.create(options);
+puter.apps.create(name, indexURL)
+puter.apps.create(name, indexURL, title)
+puter.apps.create(name, indexURL, title, description)
+puter.apps.create(options)
 ```
 
 ## Parameters
diff --git a/src/Apps/delete.md b/src/Apps/delete.md
@@ -9,7 +9,7 @@ Deletes an app with the given name.
 ## Syntax
 
 ```js
-puter.apps.delete(name);
+puter.apps.delete(name)
 ```
 
 ## Parameters
diff --git a/src/Apps/get.md b/src/Apps/get.md
@@ -9,8 +9,8 @@ Returns an app with the given name. If the app does not exist, the promise will
 ## Syntax
 
 ```js
-puter.apps.get(name);
-puter.apps.get(name, options);
+puter.apps.get(name)
+puter.apps.get(name, options)
 ```
 
 ## Parameters
diff --git a/src/Apps/list.md b/src/Apps/list.md
@@ -9,8 +9,8 @@ Returns an array of all apps belonging to the user and that this app has access
 ## Syntax
 
 ```js
-puter.apps.list();
-puter.apps.list(options);
+puter.apps.list()
+puter.apps.list(options)
 ```
 
 ## Parameters
diff --git a/src/Auth/getDetailedAppUsage.md b/src/Auth/getDetailedAppUsage.md
@@ -15,7 +15,7 @@ Users can only see the usage of applications they have accessed before.
 ## Syntax
 
 ```js
-puter.auth.getDetailedAppUsage(appId);
+puter.auth.getDetailedAppUsage(appId)
 ```
 
 ## Parameters
diff --git a/src/Auth/getMonthlyUsage.md b/src/Auth/getMonthlyUsage.md
@@ -9,7 +9,7 @@ Get the user's current monthly resource usage in the Puter ecosystem.
 ## Syntax
 
 ```js
-puter.auth.getMonthlyUsage();
+puter.auth.getMonthlyUsage()
 ```
 
 ## Parameters
diff --git a/src/Auth/getUser.md b/src/Auth/getUser.md
@@ -9,7 +9,7 @@ Returns the user's basic information.
 ## Syntax
 
 ```js
-puter.auth.getUser();
+puter.auth.getUser()
 ```
 
 ## Parameters
diff --git a/src/Auth/isSignedIn.md b/src/Auth/isSignedIn.md
@@ -9,7 +9,7 @@ Checks whether the user is signed into the application.
 ## Syntax
 
 ```js
-puter.auth.isSignedIn();
+puter.auth.isSignedIn()
 ```
 
 ## Parameters
diff --git a/src/Auth/signIn.md b/src/Auth/signIn.md
@@ -17,8 +17,8 @@ The `puter.auth.signIn()` function must be triggered by a user action (such as a
 ## Syntax
 
 ```js
-puter.auth.signIn();
-puter.auth.signIn(options);
+puter.auth.signIn()
+puter.auth.signIn(options)
 ```
 
 ## Parameters
diff --git a/src/Auth/signOut.md b/src/Auth/signOut.md
@@ -9,7 +9,7 @@ Signs the user out of the application.
 ## Syntax
 
 ```js
-puter.auth.signOut();
+puter.auth.signOut()
 ```
 
 ## Parameters
diff --git a/src/FS/copy.md b/src/FS/copy.md
@@ -9,8 +9,8 @@ Copies a file or directory from one location to another.
 ## Syntax
 
 ```js
-puter.fs.copy(source, destination);
-puter.fs.copy(source, destination, options);
+puter.fs.copy(source, destination)
+puter.fs.copy(source, destination, options)
 ```
 
 ## Parameters
diff --git a/src/FS/delete.md b/src/FS/delete.md
@@ -9,8 +9,8 @@ Deletes a file or directory.
 ## Syntax
 
 ```js
-puter.fs.delete(path);
-puter.fs.delete(path, options);
+puter.fs.delete(path)
+puter.fs.delete(path, options)
 ```
 
 ## Parameters
diff --git a/src/FS/getReadURL.md b/src/FS/getReadURL.md
@@ -7,9 +7,10 @@ platforms: [websites, apps, nodejs, workers]
 Generates a URL that can be used to read a file.
 
 ## Syntax
-```javascript
-puter.fs.getReadURL(path);
-puter.fs.getReadURL(path, expiresIn);
+
+```js
+puter.fs.getReadURL(path)
+puter.fs.getReadURL(path, expiresIn)
 ```
 
 ## Parameters
@@ -30,4 +31,4 @@ A promise that resolves to a URL string that can be used to read the file.
 
 ```javascript
 const url = await puter.fs.getReadURL("~/myfile.txt");
-```
+```
diff --git a/src/Hosting/delete.md b/src/Hosting/delete.md
@@ -9,7 +9,7 @@ Deletes a subdomain from your account. The subdomain will no longer be served by
 ## Syntax
 
 ```js
-puter.hosting.delete(subdomain);
+puter.hosting.delete(subdomain)
 ```
 
 ## Parameters
diff --git a/src/Hosting/update.md b/src/Hosting/update.md
@@ -9,7 +9,7 @@ Updates a subdomain to point to a new directory. If directory is not specified,
 ## Syntax
 
 ```js
-puter.hosting.update(subdomain, dirPath);
+puter.hosting.update(subdomain, dirPath)
 ```
 
 ## Parameters
diff --git a/src/KV/decr.md b/src/KV/decr.md
@@ -9,9 +9,9 @@ Decrements the value of a key. If the key does not exist, it is initialized with
 ## Syntax
 
 ```js
-puter.kv.decr(key);
-puter.kv.decr(key, amount);
-puter.kv.decr(key, pathAndAmount);
+puter.kv.decr(key)
+puter.kv.decr(key, amount)
+puter.kv.decr(key, pathAndAmount)
 ```
 
 ## Parameters
diff --git a/src/KV/incr.md b/src/KV/incr.md
@@ -9,9 +9,9 @@ Increments the value of a key. If the key does not exist, it is initialized with
 ## Syntax
 
 ```js
-puter.kv.incr(key);
-puter.kv.incr(key, amount);
-puter.kv.incr(key, pathAndAmount);
+puter.kv.incr(key)
+puter.kv.incr(key, amount)
+puter.kv.incr(key, pathAndAmount)
 ```
 
 ## Parameters
diff --git a/src/UI/hideWindow.md b/src/UI/hideWindow.md
@@ -9,7 +9,7 @@ The `hideWindow` method allows you to hide the window of your application.
 ## Syntax
 
 ```javascript
-puter.ui.hideWindow();
+puter.ui.hideWindow()
 ```
 
 ## Parameters
diff --git a/src/UI/showWindow.md b/src/UI/showWindow.md
@@ -9,7 +9,7 @@ The `showWindow` method allows you to show the window of your application.
 ## Syntax
 
 ```javascript
-puter.ui.showWindow();
+puter.ui.showWindow()
 ```
 
 ## Parameters
diff --git a/src/Utils/appID.md b/src/Utils/appID.md
@@ -9,7 +9,7 @@ A property of the `puter` object that returns the App ID of the running applicat
 ## Syntax
 
 ```js
-puter.appID;
+puter.appID
 ```
 
 ## Examples
diff --git a/src/Utils/env.md b/src/Utils/env.md
@@ -9,7 +9,7 @@ A property of the `puter` object that returns the environment in which Puter.js
 ## Syntax
 
 ```js
-puter.env;
+puter.env
 ```
 
 ## Return value
diff --git a/src/Utils/print.md b/src/Utils/print.md
@@ -9,7 +9,7 @@ Prints a string by appending it to the body of the document. This is useful for
 ## Syntax
 
 ```js
-puter.print(text);
+puter.print(text)
 ```
 
 ## Parameters
diff --git a/src/Utils/randName.md b/src/Utils/randName.md
@@ -9,8 +9,8 @@ A function that generates a domain-safe name by combining a random adjective, a
 ## Syntax
 
 ```js
-puter.randName();
-puter.randName(separator);
+puter.randName()
+puter.randName(separator)
 ```
 
 ## Parameters
diff --git a/src/Workers/exec.md b/src/Workers/exec.md
@@ -9,7 +9,7 @@ Sends a request to a worker endpoint while automatically passing your authentica
 ## Syntax
 
 ```js
-puter.workers.exec(workerURL, options);
+puter.workers.exec(workerURL, options)
 ```
 
 ## Parameters
diff --git a/src/Workers/list.md b/src/Workers/list.md
@@ -9,7 +9,7 @@ Lists all workers in your account with their details.
 ## Syntax
 
 ```js
-puter.workers.list();
+puter.workers.list()
 ```
 
 ## Parameters
