ballerina-lang
ballerina-lang copied to clipboard
[Improvement]: Add README.md as the primary documentation file for library packages
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 .md
file 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