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

Fix docs formatting and typo #1750

Merged
merged 2 commits into from
Feb 6, 2022
Merged

Fix docs formatting and typo #1750

merged 2 commits into from
Feb 6, 2022

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Feb 3, 2022 •
edited
Loading

What is the purpose of this pull request?

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

Overview of changes:
A minor docs update to fix two small issues I saw when reading the user guide:

  • The markdown list is not working in a model due to inline include
    image
  • Some typo and duplication
    image

Edit:

  • fix one broken link in devGuide

Anything you'd like to highlight / discuss:
nil

Testing instructions:
nil

Proposed commit message: (wrap lines at 72 characters)
Fix docs formatting and typo

Checklist: ☑️

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

@tlylt tlylt changed the title Fix user guide formatting and typo Fix docs formatting and typo Feb 4, 2022
jonahtanjz
jonahtanjz approved these changes Feb 5, 2022
View reviewed changes
Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

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

Thanks for the catch @tlylt!

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone Feb 5, 2022
ryoarmanda
ryoarmanda approved these changes Feb 5, 2022
View reviewed changes
Copy link
Contributor

@ryoarmanda ryoarmanda left a comment

Choose a reason for hiding this comment

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

LGTM! Its good to keep these things up-to-date, maybe we should have a day vetting through all of the docs.

@jonahtanjz jonahtanjz merged commit cd5b672 into MarkBind:master Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ryoarmanda ryoarmanda ryoarmanda approved these changes

@jonahtanjz jonahtanjz jonahtanjz approved these changes

Assignees
No one assigned
Labels
a-Documentation 📝
Projects
None yet
Milestone
4.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@tlylt @ryoarmanda @jonahtanjz