Adding additional docs contribution files. (#849)

This commit is contained in:
satbir121 2020-10-01 14:20:56 +05:30 committed by GitHub
parent 751dfc92ed
commit b413a399fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 93 additions and 0 deletions

View File

@ -0,0 +1,37 @@
# Action docs
Following actions are available inside code editor in appsmith:
api.run()
query.run()
showModal()
closeModal()
showAlert()
storeValue()
download()
navigateTo()
Steps to contribute:
1. Create a appsmith-docs/actions/<action>.md file.
2. Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
## Action docs template
Copy paste this template
```
---
description: >-
Action Description
---
# ActionName
## Parameters
| Param | Description |
| :--------- | :----------------- |
| **param1** | param1 description |
| **param2** | param2 description |
| **param3** | param3 description |
## Image/gif of the widget and the icon in widget creation sidebar.
## Example
```

View File

@ -0,0 +1,3 @@
# Uploading and using assets
Use `appsmith-docs/.gitbook/assets/` folder to upload the assets.
These assets can be used through the relative path to `.gitbook/assets/asset.jpg` file.

View File

@ -0,0 +1,21 @@
# DB Integration docs
Create a appsmith-docs/db-integrations/<integratiom>.md file.
Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
## Action docs template
Copy paste this template
```
---
description: >-
Integration Description
---
# Integration Name
## Link to the official documentation
## Example of Passing Data from widgets
## Example of Displaying Data in widgets
```

View File

@ -0,0 +1,32 @@
# Widget docs
Create a appsmith-docs/widget-reference/<widget>.md file.
Follow the [asset-upload](./asset-upload.md) guidelines to upload and use an asset in docs.
## Widget docs template
Copy paste this template
```
---
description: >-
Widget Description
---
# WidgetName
## Image/gif of the widget and the icon in widget creation sidebar.
## Usage with dynamic bindings
## Properties
| Property | Description |
| :------------ | :-------------------- |
| **property1** | Property1 description |
| **property2** | Property2 description |
| **property3** | Property3 description |
| Action | Description |
| :---------- | :------------------ |
| **action1** | action1 description |
| **action2** | action2 description |
| **action3** | action3 description |
```