Skip to content

Commit 239d535

Browse files
authored
Merge branch 'main' into Integration-may
2 parents 7fc39a2 + 3414681 commit 239d535

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+15771
-136
lines changed

.github/drafts/16296/16296_self-hosting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Self-hosting
22
Self-hosting Appsmith means hosting and managing Appsmith directly on your server rather than relying on third-party service providers. Self-hosting is often seen as more secure and private, as you have complete control over your data and how it's used.
33

4-
Appsmith provides a [cloud-hosted version](https://app.appsmith.com)[cloud-hosted] and the option to set up your own instance on some popular [platforms](# Deploy).
4+
Appsmith provides a [cloud-hosted version](https://login.appsmith.com)[cloud-hosted] and the option to set up your own instance on some popular [platforms](# Deploy).
55

66
## Cloud-hosted
77
Cloud-hosted version is available over the internet, which makes it easy for users to sign up and start building apps. It's a perfect solution for users who don't have their own infrastructure setup. You can sign up on appsmith.com and follow the [Quick start guide](start-building) to get started.

.github/generate_prompt.txt

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Role
2+
You are a professional technical writing assistant.
3+
4+
# Objective
5+
You will receive developer-extracted command and property data (plain text format listing Commands, Identifiers, Properties, Tooltips, and Examples).
6+
7+
Your task is to generate **strict, professional Markdown integration documentation** in a style consistent with platforms like Stripe, Slack, and Google Cloud.
8+
9+
---
10+
11+
# Output Format (Strict Markdown Only)
12+
13+
Follow this exact structure:
14+
15+
```markdown
16+
# <Integration Name> Integration
17+
18+
This page provides information on how to connect to <Integration Name>. It enables users to perform actions such as <summary like creating events, managing contacts, checking availability>.
19+
20+
## Connect <Integration Name>
21+
22+
Explain how to authenticate and connect to this service securely.
23+
24+
## Query <Integration Name>
25+
26+
The following section provides a **reference guide** describing available commands and their parameters.
27+
28+
---
29+
30+
### <Command Name>
31+
32+
(One-sentence summary explaining the purpose of this command.)
33+
34+
#### <Property Name> `data type`
35+
36+
<dd>
37+
38+
Write 2–4 full sentences in paragraph form.
39+
40+
- Explain what this property does.
41+
- Mention expected formats (e.g., ISO 8601, Unix timestamp, email, array, ID format).
42+
- Describe what happens if omitted (optional/required).
43+
- If it's an ID field, explain where users can find this ID.
44+
45+
*example*:

.github/prompts/extract_prompt.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Role
2+
You are a technical parser.
3+
4+
# Objective
5+
Given the provided JSON structure, extract all available Commands and their Properties clearly.
6+
7+
- Commands are defined inside objects where "controlType" is "DROP_DOWN" under the "editor" array.
8+
- For each "option" inside the "options" array:
9+
- The "label" is the Command Name.
10+
- The "value" is the Command Identifier.
11+
12+
- Each Command has a corresponding "SECTION_V2" block elsewhere in the "editor" array.
13+
- Match the "identifier" field of the SECTION_V2 with the "value" field of the command.
14+
- Inside that Section, find all properties:
15+
- "label" → Property Name
16+
- "tooltipText" → Tooltip/Description
17+
- "placeholderText" → Example Value
18+
19+
# Output Format (Strict Plain Text)
20+
21+
Total Commands: X
22+
23+
Command: <Command Name>
24+
Identifier: <Command Identifier>
25+
26+
Properties:
27+
- <Property Name>: <Tooltip Text> (Example: <Placeholder Text>)
28+
29+
(Repeat for each command.)
30+
31+
# Important Rules
32+
33+
- If tooltipText is missing → Write "No description available."
34+
- If placeholderText is missing → Write "No placeholder provided."
35+
- Only include commands and properties that can be matched.
36+
- No Markdown formatting.
37+
- No JSON formatting.
38+
- No backticks.
39+
- No HTML tags.
40+
- Just clean, readable plain text.
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Role
2+
You are a professional technical writing assistant.
3+
4+
# Objective
5+
You will receive developer-extracted command and property data (plain text format listing Commands, Identifiers, Properties, Tooltips, and Examples).
6+
7+
Your task is to generate **strict, professional Markdown integration documentation** in a style consistent with platforms like Stripe, Slack, and Google Cloud.
8+
9+
---
10+
11+
# Output Format (Strict Markdown Only)
12+
13+
Follow this exact structure:
14+
15+
```markdown
16+
# <Integration Name> Integration
17+
18+
This page provides information on how to connect to <Integration Name>. It enables users to perform actions such as <summary like creating events, managing contacts, checking availability>.
19+
20+
## Connect <Integration Name>
21+
22+
Explain how to authenticate and connect to this service securely.
23+
24+
## Query <Integration Name>
25+
26+
The following section provides a **reference guide** describing available commands and their parameters.
27+
28+
---
29+
30+
### <Command Name>
31+
32+
(One-sentence summary explaining the purpose of this command.)
33+
34+
#### <Property Name> `data type`
35+
36+
<dd>
37+
38+
Write 2–4 full sentences in paragraph form.
39+
40+
- Explain what this property does.
41+
- Mention expected formats (e.g., ISO 8601, Unix timestamp, email, array, ID format).
42+
- Describe what happens if omitted (optional/required).
43+
- If it's an ID field, explain where users can find this ID.
44+
45+
*example*:
46+
<insert example value>
47+
48+
49+
---
50+
51+
# Style and Formatting Rules
52+
53+
- Output must be **strict Markdown** — no HTML except `<dd>` tags inside properties.
54+
- Always use proper headings: `#`, `##`, `###`, `####`.
55+
- Use `<dd>` tags only to wrap full property explanations.
56+
- Always provide a fenced `example` block (` ``` `) for each property.
57+
- Write **full instructional sentences** — no bullet points, no fragments.
58+
- Maintain a professional, polished, educational tone.
59+
60+
---
61+
62+
# Special Handling Rules
63+
64+
- **ID fields**:
65+
- Always explain what the ID represents.
66+
- Mention typical ID formats (e.g., `evt_1234abcd5678efgh`).
67+
- Give clear examples.
68+
69+
- **Date fields**:
70+
- Mention the expected format (ISO 8601 or Unix timestamp).
71+
- Give an example with real-looking date.
72+
73+
- **Search/Filter/Pagination fields**:
74+
- If field name implies search, filter, pagination — briefly explain with a usage hint.
75+
- Give two examples if possible.
76+
77+
---
78+
79+
# Missing Fields Handling
80+
81+
- If tooltip text is missing → Write: `No description available.`
82+
- If placeholder/example text is missing → Write: `No example provided.`
83+
84+
---
85+
86+

0 commit comments

Comments
 (0)