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

Explain docs-internal links in Renovate style guide #29619

Open
4 tasks
HonkingGoose opened this issue Jun 12, 2024 · 2 comments
Open
4 tasks

Explain docs-internal links in Renovate style guide #29619

HonkingGoose opened this issue Jun 12, 2024 · 2 comments
Assignees
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

Describe the proposed change(s).

Explain the correct link format for links to docs-internal pages in the Renovate style guide.

Todos:

  • Explain correct link format.
  • Show examples of the correct link format.
  • Explain how to confirm the link points to the right file, and right location in the file (anchor).
  • Any helpful tips/tricks.

I'll let a maintainer write these docs, because I'm the one messing up the links every time... 🙈

Related discussion which was approved by @rarkins:

@HonkingGoose HonkingGoose added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation labels Jun 12, 2024
@HonkingGoose
Copy link
Collaborator Author

@viceice is this something you want to work on? You usually get my bad links sorted out for me. 😉

@viceice
Copy link
Member

viceice commented Jun 12, 2024

when I find some time 🙈

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation
Projects
None yet
Development

No branches or pull requests

2 participants