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.

Sign up for GitHub

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

Jump to bottom

[Improvement]: Make the content of generated md files to be markdown compatible #42907

Open
TharmiganK opened this issue Jun 12, 2024 · 8 comments · May be fixed by #43925
Open

[Improvement]: Make the content of generated md files to be markdown compatible #42907

TharmiganK opened this issue Jun 12, 2024 · 8 comments · May be fixed by #43925
Assignees
@thil4n
Labels
Area/CLI-BuildTools Credits/20 good first issue Hacktoberfest Type/Improvement

Comments

@TharmiganK
Copy link
Contributor

Description

We can create a ballerina library package using the following command:

$ bal new -t lib socialMedia

This creates the module.md and package.md with the content which is not markdown compatible

Describe your problem(s)

The generated md file has the following line which is not markdown compatible:

Prints "Hello, World!" with a main function.
[//]: # (above is the package summary)
Screenshot 2024-06-12 at 09 18 36

Describe your solution(s)

Generate some descriptive sample which is markdown compatible

Related area

-> Other Area

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response
@ballerina-bot ballerina-bot added the needTriage The issue has to be inspected and labeled manually label Jun 12, 2024
@Dilhasha Dilhasha added Area/CLI-BuildTools and removed needTriage The issue has to be inspected and labeled manually labels Jun 12, 2024
@lwpamihiranga
Copy link
Contributor

lwpamihiranga commented Jul 4, 2024 •
edited
Loading

Hi,

I've noticed that these .md files are not generated in the master branch build, but they are available when tested with Ballerina version 2201.9.1 (Swan Lake Update 9). Could you please let me know which branch would be the most appropriate for me to apply the fix to?

Thanks!

bal-new-master-vs-22010901

@azinneera
Copy link
Contributor

Hi,

I've noticed that these .md files are not generated in the master branch build, but they are available when tested with Ballerina version 2201.9.1 (Swan Lake Update 9). Could you please let me know which branch would be the most appropriate for me to apply the fix to?

Thanks!

bal-new-master-vs-22010901

Hi @lwpamihiranga

Sorry for the late response. We had merged some changes to the master branch and now we reverted it. Please check the master branch now and you should be able to MD file content.

@gayaldassanayake gayaldassanayake added the Points/0.5 Equivalent to half a day effort label Sep 24, 2024
@markoeltiger
Copy link

Hello @azinneera @gayaldassanayake , I would like to work on it can you please assign it to me?

@azinneera azinneera moved this to In Progress in Good First Issues Oct 7, 2024
@azinneera
Copy link
Contributor

azinneera commented Oct 7, 2024 •
edited by keizer619
Loading

Hi @markoeltiger,

I have assigned this issue to you.

To help you get started, here are some essential resources:

  1. Understanding Ballerina Platform:
    Learn what Ballerina is all about: Ballerina Platform
  2. How to Contribute:
    Read our contributing guidelines to understand how you can contribute effectively: Contribution Guide
  3. Contributing to the Ballerina library:
    If you're interested in contributing to our library, here are the guidelines: Library Contribution Guide
  4. Learn Ballerina:
    If you're new to Ballerina or want to enhance your skills, our official website offers a wealth of learning resources: Learn Ballerina
  5. Get Help and Connect:
    Ask technical questions on Stack Overflow with Ballerina tag and join our Discord community Ballerina Discord

@azinneera azinneera added Credits/20 and removed Points/0.5 Equivalent to half a day effort labels Oct 7, 2024
@keizer619
Copy link
Member

@markoeltiger Are you working on this? If not let us know to open it for others

@thil4n
Copy link

thil4n commented Jan 21, 2025

Hi, I'd like to work on this.

@keizer619
Copy link
Member

keizer619 commented Jan 29, 2025 •
edited
Loading

Hi, I'd like to work on this.

@thil4n Yes you can work on this.

Note that we are rewarding external contributors, please refer the website for more details

@thil4n thil4n linked a pull request Mar 17, 2025 that will close this issue
Open
13 tasks
@thil4n
Copy link

thil4n commented Mar 17, 2025

Hi, I opened a PR for this fix. #43925

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thil4n thil4n

Labels
Area/CLI-BuildTools Credits/20 good first issue Hacktoberfest Type/Improvement
Projects
Good First Issues
Status: Todo
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make the content of generated md files to be markdown compatible thil4n/ballerina-lang
9 participants
@keizer619 @Dilhasha @azinneera @ballerina-bot @gayaldassanayake @lwpamihiranga @markoeltiger @thil4n @TharmiganK