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

Update doc #2415

Merged
merged 22 commits into from Feb 12, 2024
Merged

Update doc #2415

merged 22 commits into from Feb 12, 2024

Conversation

yiwen101
Copy link
Contributor

@yiwen101 yiwen101 commented Feb 12, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Resolves #2371

**Overview of changes:
Add the rule of using markdown in presentation component in "trouble shooting" and "presentation components" section of the user doc.
Update the code example of the four presentation component

Anything you'd like to highlight/discuss:
NA

Testing instructions:
NA

Proposed commit message: (wrap lines at 72 characters)
Update user doc on markdown syntax for presentation component


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a6ef6cc) 48.87% compared to head (d4da19f) 48.87%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2415   +/-   ##
=======================================
  Coverage   48.87%   48.87%           
=======================================
  Files         124      124           
  Lines        5238     5238           
  Branches     1109     1109           
=======================================
  Hits         2560     2560           
  Misses       2371     2371           
  Partials      307      307           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@yucheng11122017 yucheng11122017 left a comment

Choose a reason for hiding this comment

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

LGTM

@yucheng11122017 yucheng11122017 merged commit 7d9cf5a into MarkBind:master Feb 12, 2024
8 checks passed
@yucheng11122017 yucheng11122017 added the r.Minor Version resolver: increment by 0.1.0 label Feb 24, 2024
@kaixin-hc
Copy link
Contributor

@all-contributors please add @yiwen101 for doc

Copy link
Contributor

@kaixin-hc

I've put up a pull request to add @yiwen101! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Minor Version resolver: increment by 0.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Icons in 'Presentation' components (e.g. box, panels, tabs) are not rendered properly
3 participants