ballerina-central icon indicating copy to clipboard operation
ballerina-central copied to clipboard

Use the package.json of BALA files to render package and module documentations

Open azinneera opened this issue 6 months ago • 1 comments

Description: Related lang issue: https://github.com/ballerina-platform/ballerina-lang/issues/42981

With these changes, the package.json of the BALA will be added with the "docs" field as shown below. BC can read this entry and render the documentation.

{
  "organization": "asmaj",
  "name": "readmeTest",
  "version": "0.1.0",
  "export": [
    "readmeTest"
  ],
  "docs": {
    "readmeTest.mod1": "docs/readmeTest.mod1/Module.md", // Optional. pattern- "<moduleName>" : "<docPath>"
    "readmeTest": "docs/Package.md" // Mandatory. pattern- "<packageName>" : "<docPath>"
  },
  "ballerina_version": "2201.10.0-SNAPSHOT",
  "implementation_vendor": "WSO2",
  "language_spec_version": "2024R1",
  "platform": "any",
  "graalvmCompatible": true,
  "template": false
}

Note: With the new structure, documentation for the default module is also expected to be contained in the package documentation MD file. Therefore, the Module.md of the default module will not be packaged into the BALA.

azinneera avatar Jul 31 '24 09:07 azinneera