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

Extend documentation for relative links #16970

Merged
merged 3 commits into from
Jun 7, 2022
Merged

Extend documentation for relative links #16970

merged 3 commits into from
Jun 7, 2022

Conversation

Marcono1234
Copy link
Contributor

@Marcono1234 Marcono1234 commented Apr 10, 2022

Why:

Closes [issue link]

Extend the documentation for relative links, mentioning that:

  • Links are relative to the file in which they appear
  • Links starting with / are relative to the repository root

Both of this is currently not explicitly mentioned, but users already rely on it and other documentation sections, such as "Basic writing and formatting syntax" > "Images" make use of it as well.

The wording of the new sentences might not be ideal; any feedback is appreciated.

What's being changed:

see "Why" above

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 10, 2022
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Apr 11, 2022
@ramyaparimi
Copy link
Contributor

@Marcono1234
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilene janiceilene added the SME reviewed An SME has reviewed this issue/PR label Jun 1, 2022
Copy link
Contributor

@janiceilene janiceilene left a comment

Choose a reason for hiding this comment

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

Thanks so much for opening a PR with this fix 🎉 It looks great! I'll update the branch and get this merged once tests are passing 🍏

@janiceilene janiceilene added the ready to merge This pull request is ready to merge label Jun 7, 2022
@janiceilene janiceilene merged commit c1b79af into github:main Jun 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jun 7, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@Marcono1234 Marcono1234 deleted the patch-2 branch June 7, 2022 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge repositories Content related to repositories SME reviewed An SME has reviewed this issue/PR waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants