Refactor the Ballerina Docs for the Alfresco Connector

[SachinAkash01]

Description

$subject

Fixes: ballerina-platform/ballerina-library#7922

Related Pull Requests (remove if not relevant)

• Pull request 1
• Pull request 2

One line release note:

• One line describing the feature/improvement/fix made by this PR

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

• Ballerina Version:
• Operating System:
• Java SDK:

Checklist:

Changes to OpenAPI definition

• Modified info section of the OpenAPI definition file - Example

  • description - what the connector is about
  • x-ballerina-init-description OpenAPI extension - connector initialization details
  • x-ballerina-display OpenAPI extension - connector name and path to the connector icon

• Added proper description each API Key, if API Key authentication is defined in OpenAPI definition file

Changes to connector module

• Added license header at the top of each .bal file.
• Added Package.md as per the guide here
• Added Module.md for the module of the connector as per the guide here
• Added connector icon to the root of the connector. Icon needs to be a png of 200x200 px size with name icon.png
• Added Ballerina.toml file with following information. For keywords refer to guide

Verifying connector module

• Compiled the connector successfully with the targeted ballerina version.
• Conducted smoke tests on the connector (Recommended when OpenAPI definition is obtain from an unofficial source)

Security checks

• Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines?
• Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets?

[ayeshLK]

Shall we follow the same structure as the revamped connectors for quick-start guide ?

https://github.com/ballerina-platform/module-ballerinax-stripe?tab=readme-ov-file#quickstart

[Copilot]

Pull Request Overview

This PR refactors the Quickstart documentation for the Alfresco connector, updating authentication instructions, renaming configuration types, and adding execution steps.

• Clarifies Basic Authentication setup and removes bearer token step
• Updates code snippets to use alfresco:ConnectionConfig with username/password
• Adds a “Run” step with the bal run command

Comments suppressed due to low confidence (2)

openapi/alfresco/Module.md:29

• [nitpick] Consider renaming the variable clientConfig to connectionConfig to match its type and improve consistency.

alfresco:ConnectionConfig clientConfig = {

openapi/alfresco/Module.md:43

• The example uses serviceURL but does not define it; include a configurable string serviceURL = ?; declaration above so the snippet is self-contained.

alfresco:Client baseClient = check new (clientConfig, serviceURL);