Merge branch 'master' into release

# Conflicts:
#	contributions/docs/CONTRIBUTING.md
This commit is contained in:
Nikhil Nandagopal 2020-10-01 18:57:19 +05:30
commit e58bc67b36
3 changed files with 56 additions and 4 deletions

View File

@ -0,0 +1,20 @@
---
name: "\U0001F4D6 Documentation Improvement"
about: Suggest improvements to our documentation
title: "[Docs] "
labels: Documentation
assignees: Nikhil-Nandagopal
---
## Documentation Link
Add a link to the page which needs improvement (if relevant)
## Describe the problem
Is the documentation missing? Or is it confusing? Why is it confusing?
## Describe the improvement
A clear and concise description of the improvement.

View File

@ -28,7 +28,7 @@ Before raising a pull request, ensure you have raised a corresponding issue and
To maintain consistency, we have a set structure for the different types of documentation pages on appsmith. Refer to the following when updating the docs
- [Documenting Widgets](docs/Widgets.md)
- [Documenting Actions](docs/Actions.md)
- [Documenting DB Integrations](docs/DB%20Integrations.md)
- [Uploading Assets](docs/UploadingAssets.md)
- [Documenting Widgets](Widgets.md)
- [Documenting Functions](InternalFunctions.md)
- [Documenting DB Integrations](DB%20Integrations.md)
- [Uploading Assets](UploadingAssets.md)

View File

@ -0,0 +1,32 @@
# Internal Function docs
Steps to contribute:
1. Create a appsmith-docs/function-reference/<function>.md file.
2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs.
## Functions docs template
Copy paste this template in the file you are updating
```bash
---
description: >-
Description of the function
---
# Function Name
## Signature
##
function signature wrapped in code blocks
#### Arguments
| Argument Name | Description |
| :--- | :--- |
| **Argument Name** | Argument Description |
## Image / gif of the function being used
```
[Example Doc](https://github.com/appsmithorg/appsmith-docs/blob/v1.2/function-reference/show-modal.md)