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

feat(examples): Implement markdown package #2912

Merged
merged 35 commits into from
Feb 6, 2025

Conversation

sunspirit99
Copy link
Contributor

@sunspirit99 sunspirit99 commented Oct 5, 2024

From #2753

I keep this PR open to see if I am on the right approach. If it's suitable, I'll investigate to make further improvements and provide implementation examples in the Render() functions of some current demo realms to demonstrate the use of this package

Screenshot from 2024-10-23 19-28-43

cc @moul

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@sunspirit99 sunspirit99 requested review from a team as code owners October 5, 2024 12:59
@sunspirit99 sunspirit99 requested review from jaekwon and thehowl and removed request for a team October 5, 2024 12:59
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Oct 5, 2024
Copy link

codecov bot commented Oct 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@moul
Copy link
Member

moul commented Oct 8, 2024

It's heading in the right direction by avoiding HTML, unlike other recent PRs. However, the current implementation isn't complete or appealing enough for me yet, though it may be for others.

I believe it makes sense to view this PR not as a UI framework proposal but as a minimal md library. This library can be used by you or anyone else to build various UI frameworks. I'm fine with that direction. Therefore, you should rename markdown to md.

Copy link
Member

@moul moul left a comment

Choose a reason for hiding this comment

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

I provided some opinionated feedback. I believe the current library is similar to ufmt and can be merged early, allowing us to improve it over time.

I would prefer if you renamed it to md. Additionally, please create a demo realm to showcase its capabilities.

That said, I'm fine with merging early.

@gfanton
Copy link
Member

gfanton commented Oct 14, 2024

@moul I'm fine with merging this, but I'm hesitant about using the md module for now. Multiple ideas are emerging for an md framework. Should we consider moving this to a submodule instead, allowing others to submit their ideas? I'm concerned about having multiple libraries without coherence, all doing the same thing.

@gfanton gfanton mentioned this pull request Nov 5, 2024
6 tasks
@leohhhn
Copy link
Contributor

leohhhn commented Nov 7, 2024

@sunspirit99

Can you move this code to your personal/company namespace?

@sunspirit99
Copy link
Contributor Author

@sunspirit99

Can you move this code to your personal/company namespace?

752ebf3 i've moved to my new house

Copy link
Contributor

@leohhhn leohhhn left a comment

Choose a reason for hiding this comment

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

Let's merge and see how people use this lib; maybe it will need some iteration.

cc @moul

EDIT: awaiting some internal discussions; I'll remove the "don't merge" label after them.

@leohhhn leohhhn added the don't merge Please don't merge this functionality temporarily label Nov 12, 2024
@thehowl thehowl added bounty and removed bounty labels Dec 12, 2024
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Dec 12, 2024

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
  • The pull request description provides enough details (checked by @thehowl)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: sunspirit99/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🟢 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission
The pull request description provides enough details

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

@thehowl thehowl added the bounty/candidate PR is candidate to receive a bounty. label Dec 12, 2024
@michelleellen
Copy link
Contributor

Hey @sunspirit99

Congrats, on completing a Gno bounty! We’ve reviewed your submission and will be merging your PR shortly. Your work falls under the ‘competing implementation’ bounty category (https://github.com/gnolang/bounties). The initial bounty is awarded for getting it working, if you could add some documentation or testing that would be even better. Please share your email, and I’ll get in touch.

There’s a Part B to this bounty that you can compete for if you’re interested, an adoption bounty. We recommend:

  • Adding solid documentation for easy integration
  • Creating resources to showcase its value
  • Engaging with the community to drive usage
  • Provide engagement metrics on your tool

If you demonstrate a complete tool, and user metrics and adoption, which is organic and verifiable, an additional adoption bounty may be on the table. Take a look at the bounty repo above for more details. Join a bi-weekly Wednesday call or Discord Gnome Spotlight to showcase your work, and find creative ways to attract users.

cc: @leohhhn @thehowl

@leohhhn leohhhn removed the don't merge Please don't merge this functionality temporarily label Feb 6, 2025
@leohhhn leohhhn merged commit dcd3834 into gnolang:master Feb 6, 2025
61 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty/candidate PR is candidate to receive a bounty. 🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

8 participants