Skip to content

Add intra-site link instructions to docs#2276

Merged
itsyme merged 9 commits intoMarkBind:masterfrom
itsyme:add-links-docs
Apr 10, 2023
Merged

Add intra-site link instructions to docs#2276
itsyme merged 9 commits intoMarkBind:masterfrom
itsyme:add-links-docs

Conversation

@itsyme
Copy link
Contributor

@itsyme itsyme commented Apr 9, 2023

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:

Overview of changes:
Related to #2273. Added a section in "Contribute to Documentation" to explain the use tags when adding intra-site links. Added a box to "Implement a New Feature" to remind developers to use tags in intra-site links.

Anything you'd like to highlight/discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Add intra-site link instructions to docs


Checklist: ☑️

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

Copy link
Contributor

@tlylt tlylt left a comment

Choose a reason for hiding this comment

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

Can we include the rationale of why the tags work? (the part about using absolute link vs relative link)?

@tlylt tlylt added this to the v4.1.1 milestone Apr 9, 2023
Copy link
Contributor

@lhw-1 lhw-1 left a comment

Choose a reason for hiding this comment

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

LGTM! Just some wording nits :)

itsyme and others added 4 commits April 10, 2023 13:04
Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>
Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>
Co-authored-by: Lee Hyung Woon / 이형운 <leehyungwoonsamuel@gmail.com>
@itsyme itsyme merged commit fe00ede into MarkBind:master Apr 10, 2023
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.

3 participants