Skip to content

Comments

Add documentation with an example#5

Merged
Nuvindu merged 35 commits intoballerina-platform:mainfrom
Thinuriw:main
Feb 27, 2025
Merged

Add documentation with an example#5
Nuvindu merged 35 commits intoballerina-platform:mainfrom
Thinuriw:main

Conversation

@Thinuriw
Copy link
Contributor

@Thinuriw Thinuriw commented Feb 25, 2025

Purpose

Add documentation with relevant example. Improves clarity and helps with better usage understanding.

Examples

Checklist

  • Linked to an issue
  • Updated the changelog
  • Added tests
  • Updated the spec
  • Checked native-image compatibility

Nuvindu
Nuvindu reviewed Feb 25, 2025
View reviewed changes
Nuvindu
Nuvindu reviewed Feb 25, 2025
View reviewed changes
Thinuriw and others added 8 commits February 25, 2025 15:10
@Thinuriw @Nuvindu
Fix sentence in Step 2 of README.md
9a6f7c5 
Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
@Thinuriw @Nuvindu
Fix sentence in Step 2 of ballerina/README.md
98b10b9 
Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
@Thinuriw @Nuvindu
remove the local dependency in examples/create-event/Ballerina.toml
d2e312c 
Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
@Thinuriw @Nuvindu
Remove return() in examples/create-event/main.bal
a0d8f7f 
Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
@Thinuriw @Nuvindu
Format the url for the developer key image in README.md
4c560fd 
Co-authored-by: Nuvindu Nirmana <63797478+Nuvindu@users.noreply.github.com>
@Thinuriw
Add license header and format the examples/create-event/main.bal
192311c
@Thinuriw
Format main.bal file in example/create-event/
76c0ff5
@Thinuriw
Change and update all the README.md files with the correct urls and s…
02196bd 
…entence cases.
ThisaruGuruge
ThisaruGuruge reviewed Feb 26, 2025
View reviewed changes
Thinuriw and others added 11 commits February 26, 2025 17:54
@Thinuriw
Correct grammatical errors,wordings and change all the README.md files
6122cff
@Thinuriw @ThisaruGuruge
Remove url in the heading examples/create-event/README.md
a7d9062 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Update with short hand method for variable assigning in examples/crea…
298bc2e 
…te-event/main.bal

Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Update with short hand method for variable assigning in examples/crea…
bbd2401 
…te-event/main.bal

Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Update with short hand method for variable assigning in examples/crea…
88d1081 
…te-event/main.bal

Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Add ensureType() when casting the appId in examples/create-event/main…
32c4723 
….bal

Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw
Add API word next to Hubspot CRM timelines phrase
eb0c469
@Thinuriw
Remove .devcontainer.json and .gitignore files in example folder
32b4363
@Thinuriw
Remove the unnecessary bullet point in README.md files
404f432
@Thinuriw
Add sleep() till the event template is created in the examples/create…
5dfee86 
…-event/main.bal
@Thinuriw @ThisaruGuruge
Change the org to wso2 in examples/create-event/Ballerina.toml
17f92b1 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
ThisaruGuruge
ThisaruGuruge reviewed Feb 27, 2025
View reviewed changes
@Thinuriw @ThisaruGuruge
Remove extra space for the step 2 in README.md
7e42410 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
Thinuriw and others added 10 commits February 27, 2025 10:18
@Thinuriw @ThisaruGuruge
Change markdown to text in README.md
4e4b705 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Change the order of the imports in README.md
a9d8ad1 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Update with short hand method for variable assigning in README.md
c208986 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Update with short hand method for variable assigning README.md
152ee82 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Add a space after ApiKeysConfig in README.md
024756b 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw @ThisaruGuruge
Add blockquote for the note section in README.md
e50c47f 
Co-authored-by: Thisaru Guruge <thisaru@wso2.com>
@Thinuriw
Change all README.md files with the latest changes.
a80f14e
@Thinuriw
Remove json_resp and curl_cmd images in the resource folder
1c434b5
@Thinuriw
Change the order of the imports in examples/create-event/main.bal
ce36681
@Thinuriw
Add keywords to Ballerina.toml
a7b2a86
Nuvindu
Nuvindu reviewed Feb 27, 2025
View reviewed changes
@Nuvindu Nuvindu merged commit abbb976 into ballerina-platform:main Feb 27, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ThisaruGuruge ThisaruGuruge ThisaruGuruge left review comments

@Nuvindu Nuvindu Nuvindu approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Thinuriw @ThisaruGuruge @Nuvindu