From 3e4f7a8d2c7ddfeb83108e8b88962b192ee288c7 Mon Sep 17 00:00:00 2001 From: Lim Chee Aun Date: Tue, 9 Sep 2025 18:19:57 +0800 Subject: [PATCH] Clean up with examples --- env.schema.json | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/env.schema.json b/env.schema.json index 98755233..2dfa4534 100644 --- a/env.schema.json +++ b/env.schema.json @@ -8,6 +8,7 @@ "default": "Phanpy", "minLength": 1, "maxLength": 100, + "examples": ["Phanpy Dev", "Donphan"], "description": "Client name that affects web page title, app title, OpenGraph card title, and client name for authentication" }, "PHANPY_WEBSITE": { @@ -20,22 +21,24 @@ "type": "string", "pattern": "^(?!https?://).*$", "format": "hostname", - "description": "Default instance for log-in (e.g. 'mastodon.social', without https://)" + "examples": ["mastodon.social", "hachyderm.io"], + "description": "Default instance for log-in (Exclude https://)" }, "PHANPY_DEFAULT_INSTANCE_REGISTRATION_URL": { "type": "string", "format": "uri", - "description": "URL of the instance registration page (e.g. https://mastodon.social/auth/sign_up)" + "examples": ["https://mastodon.social/auth/sign_up"], + "description": "URL of the instance registration page" }, "PHANPY_PRIVACY_POLICY_URL": { "type": "string", "format": "uri", + "examples": ["https://mastodon.social/privacy-policy"], "description": "URL of the privacy policy page" }, "PHANPY_DEFAULT_LANG": { "type": "string", - "minLength": 2, - "maxLength": 10, + "examples": ["en-US", "zh-CN"], "description": "Default language fallback after multiple detection methods" }, "PHANPY_REFERRER_POLICY": { @@ -72,11 +75,11 @@ }, "PHANPY_GIPHY_API_KEY": { "type": "string", - "minLength": 1, "description": "API key for GIPHY integration" }, "PHANPY_DISALLOW_ROBOTS": { "type": ["string", "boolean"], + "examples": ["true", "1"], "description": "Set to any value to disallow all web crawlers from indexing the site" } },