Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make README.md as the default package documentation #1810

Merged

Conversation

SachinAkash01
Copy link
Member

This PR includes the following changes:

  • Rename Module.md to README.md in the default module and submodules.
  • Remove Package.md from the default module.

Related to: ballerina-platform/ballerina-library#7404

TharmiganK
TharmiganK previously approved these changes Jan 17, 2025
@lnash94
Copy link
Member

lnash94 commented Jan 20, 2025

Suggestion: We can update the description by removing details about the validator feature since we no longer give users the courage to use it.

@SachinAkash01
Copy link
Member Author

Suggestion: We can update the description by removing details about the validator feature since we no longer give users the courage to use it.

Working on it. I will send a separate PR for that..

Copy link
Contributor

@NipunaRanasinghe NipunaRanasinghe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TharmiganK TharmiganK merged commit c790a06 into ballerina-platform:master Jan 21, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants