Update Actions.md

This commit is contained in:
Nikhil Nandagopal 2020-10-01 16:19:20 +05:30 committed by GitHub
parent 27c7dbd139
commit 902bfa33dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,27 +1,29 @@
# Action docs # Action docs
Steps to contribute: Steps to contribute:
1. Create a appsmith-docs/actions/<action>.md file. 1. Create a appsmith-docs/action-reference/<action>.md file.
2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs. 2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs.
## Action docs template ## Action docs template
Copy paste this template in the file you are updating Copy paste this template in the file you are updating
``` ```bash
--- ---
description: >- description: >-
Action Description Description of the action
--- ---
# ActionName # Action Name
## Parameters ## Signature
| Param | Description |
| :--------- | :----------------- |
| **param1** | param1 description |
| **param2** | param2 description |
| **param3** | param3 description |
## Image/gif of the action used in a widget ##
function signature of the action wrapped in code blocks
## Example #### Arguments
| Argument Name | Description |
| :--- | :--- |
| **Argument Name** | Argument Description |
## Image / gif of the action used
``` ```