[Improvement]: Add README.md as the primary documentation file for library packages #42981
Comments
ballerina-bot
added
needTriage
13 tasks
azinneera
removed
needTriage
github-project-automation
bot
moved this from In Progress
to Done
in Ballerina Team Main Board
|
The design that was finalized on 10/09/2024 is as follows: [package] # Describes the package and default module
org = "samjs"
name = "mylib"
version = "0.1.0"
description = "" # Package and default module description
distribution = "2201.11.0"
readme = "" # Package and default module document
[[package.modules]]
name = "mylib.foo" # valid only for non-default modules
description = ""
export = true # by default false
readme = ""
[[package.modules]]
name = "mylib" # default module is disallowed
description = ""The implementation was kept on hold due to the prioritization of dev rel work. |
|
With this change, we need to change the structure of the package.json in the BALA file to capture module information as well. This is currently being designed. |
13 tasks
github-project-automation
bot
moved this from In Progress
to Done
in Ballerina Team Main Board
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Currently, the documentation is captured in two files: Package.md for package documentation and additionally, a Module.md for module-specific documentation. This has to be improved to reduce to one file, and since most of the other platforms like GitHub supports README.md by default for documentation, we should use the same name.
Moreover, the user must have the option to specify a custom
.mdfile for documentation. A new field under the[package]table in the Ballerina.toml file must be introduced for this.Describe your problem(s)
No response
Describe your solution(s)
No response
Related area
-> Compilation
Related issue(s) (optional)
No response
Suggested label(s) (optional)
No response
Suggested assignee(s) (optional)
No response
The text was updated successfully, but these errors were encountered: