Skip to content

Docs Style Guide: add section on links #2911

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

Merged
MartinHjelmare merged 1 commit into from
Jan 5, 2026
+8 −0
Merged

Docs Style Guide: add section on links #2911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/documenting/general-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ A few notes about the use of markdown in this documentation:
1. List item 2.
1. List item 3.
```

## Links

- Use relative links for links on `homeassistant.io`:
- For example:
- `/connect/zbt-2/` instead of `https://www.home-assistant.io/connect/zbt-2/`
- Do not use affiliate or tracking links.

## Images

If you use images, upload them to the images folder in the documentation repository. Do not link to external images, for example on your private GitHub repository.
Expand Down