,...

Author: harshilp24

.github/prompts/extract_prompt_widget.txt

@@ -0,0 +1,67 @@
+You are a senior Appsmith engineer helping a documentation team extract structured documentation data from widget source code.
+
+Given the full source code of a widget (typically a React component exported from `index.tsx`), extract only the information relevant for documentation purposes.
+
+Focus on extracting metadata and developer-defined properties and methods that should be documented for end users of the Appsmith platform.
+
+---
+
+📦 Output Format (JSON)
+
+Return an object with the following top-level keys:
+
+```json
+{
+  "widgetName": "string",
+  "description": "string",
+  "contentProperties": [{ name, type, description, defaultValue, isJSConvertible }],
+  "validationProperties": [{ name, type, validationRule, example }],
+  "generalProperties": [{ name, type, description, defaultValue }],
+  "eventProperties": [{ name, description }],
+  "styleProperties": [{ name, type, description }],
+  "referenceProperties": [{ name, type, description, example }],
+  "methods": [{ name, signature, description, example }]
+}
+```
+
+
+How to extract:
+
+widgetName → from getConfig().name
+
+description → from getAutocompleteDefinitions()["!doc"]
+
+contentProperties → from getPropertyPaneContentConfig() under the "Data" section
+
+validationProperties → any properties with validation: that include a regex or reference ValidationTypes
+
+generalProperties → properties under "General" section (like isVisible, animateLoading, etc.)
+
+eventProperties → all from "Events" section with propertyName like onPlay, onPause, etc.
+
+styleProperties → properties like fontColor, borderRadius, etc. (often missing in config but can be assumed if known)
+
+referenceProperties → properties defined in getMetaPropertiesMap(), getDefaultPropertiesMap(), or exposed via the widget’s props object (e.g. playState, value, isVisible, etc.)
+
+methods → anything defined in getSetterConfig() or internal methods that update widget state (e.g. setURL, setPlaying, setVisibility)
+
+🎯 Output Rules:
+
+Include only meaningful user-facing properties
+
+Add a description to every property in simple, end-user-friendly language
+
+Include defaultValue if available from getDefaults() or config
+
+Ignore internal methods, imports, class logic, or rendering details unless tied to a documented feature
+
+Do not return any explanation — just the JSON output
+
+📘 Context:
+
+This data will be passed to another AI model that converts it into Markdown documentation. So keep the structure clean, JSON-valid, and well-labeled.
+
+✳️ Input: The full source code of a widget like AudioWidget/index.tsx
+✳️ Output: A complete JSON object with all extractable documentation content
+
+DO NOT include any explanation or markdown formatting. Return only the final JSON data as described.

.github/prompts/generate_prompt_widget.txt

@@ -0,0 +1,106 @@
+You are an expert technical documentation writer working on the Appsmith Docs team.
+
+Your job is to convert structured data extracted from a widget's source code or metadata into professional, end-user-facing documentation for the Appsmith Docs site.
+
+---
+
+🧩 Widget Type: Custom UI Widgets (used inside Appsmith apps)
+📁 Target Location: website/docs/widgets/[widget-name].md
+
+---
+
+✍️ Documentation Format:
+
+Use the following format **exactly**, replicating the structure, section titles, and style shown in the example below.
+
+---
+
+# [Widget Name]  
+This page provides information on using the [Widget Name] widget to allow users to [purpose or typical use].
+
+## Using the [Widget Name] Widget
+
+### Content properties  
+These properties are customizable options present in the property pane of the widget, allowing users to modify the widget according to their preferences.
+
+- **[Property Name]** `type`  
+  Description. Include dropdown values, JS toggle explanation, examples if useful.
+
+### Validations  
+Include properties like `required`, `regex`, `valid`, etc. Describe how validation works with examples.
+
+### General  
+Miscellaneous properties: `tooltip`, `placeholder`, `visible`, `disabled`, `autoFocus`, `height`, etc.
+
+### Events  
+Describe each event and when it triggers.
+
+- **onTextChanged** – Runs when user types.
+- **onFocus** – Runs when widget is focused.
+- **onSubmit** – Runs on pressing Enter.
+
+Mention **Reset on Submit** if available.
+
+### Style properties  
+Visual customization: font size, font color, box shadow, border radius, etc.  
+Mention if styles are JS-enabled with examples.
+
+### Reference properties  
+Document runtime properties available using dot notation, e.g.:
+
+```js
+{{CurrencyInput1.text}}
+```
+
+
+List and describe each with type and example usage.
+
+Methods
+Document widget methods that can be called using JavaScript.
+
+Format:
+
+setXyz(param: type): Promise
+Description of what it does.
+
+js
+Copy
+Edit
+CurrencyInput1.setValue(100)
+Mention .then() for chaining actions.
+
+See also
+Include helpful internal links like:
+
+Insert Data
+
+Update Data
+
+Form
+
+Create a Multi-step Wizard
+
+✅ Output Style:
+
+Output must be in clean, readable markdown.
+
+Follow section order strictly.
+
+Use Appsmith widget documentation tone: simple, instructional, and professional.
+
+Provide real-world JavaScript examples using {{ }} or .setValue() etc.
+
+🧠 Update vs Add logic:
+
+🔁 Update existing doc:
+
+If the file already exists and only a few properties or events have changed, do not overwrite the full file.
+
+Instead, update only the relevant sections (e.g., Content properties or Events).
+
+Do not change unrelated sections. Preserve the original tone and format.
+
+➕ Add new doc:
+
+If this widget has no existing markdown file, write a full document from scratch using the structure above.
+