Skip to content

docs: fix broken cross-reference syntax in get-started tutorial #545

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

Open
chrisbainbridge wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix broken cross-reference syntax in get-started tutorial #545

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
6 changes: 3 additions & 3 deletions docs/tutorials/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ home vlc:home :home -
(...)
```

The slot is the provider of the resource while the plug is the consumer, and a slot can support multiple plug connections. In the above output, the {ref}``camera` <interfaces-camera-interface>` interface is not connected because its slot is empty. This means VLC cannot access any connected cameras. The `<snap-name>:<interface-name>` syntax describes which snap is responsible for which component. If there's no snap, such as with `:audio-playback`, the component is directly connected to the system.
The slot is the provider of the resource while the plug is the consumer, and a slot can support multiple plug connections. In the above output, the [`camera`](interfaces-camera-interface) interface is not connected because its slot is empty. This means VLC cannot access any connected cameras. The `<snap-name>:<interface-name>` syntax describes which snap is responsible for which component. If there's no snap, such as with `:audio-playback`, the component is directly connected to the system.

@Mohit-Chachada Mohit-Chachada Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the proposed change is not incorrect but could you instead just remove the extra backticks to keep things consistent with other such (correct) references:

Suggested change
The slot is the provider of the resource while the plug is the consumer, and a slot can support multiple plug connections. In the above output, the [`camera`](interfaces-camera-interface) interface is not connected because its slot is empty. This means VLC cannot access any connected cameras. The `<snap-name>:<interface-name>` syntax describes which snap is responsible for which component. If there's no snap, such as with `:audio-playback`, the component is directly connected to the system.
The slot is the provider of the resource while the plug is the consumer, and a slot can support multiple plug connections. In the above output, the {ref}`camera <interfaces-camera-interface>` interface is not connected because its slot is empty. This means VLC cannot access any connected cameras. The `<snap-name>:<interface-name>` syntax describes which snap is responsible for which component. If there's no snap, such as with `:audio-playback`, the component is directly connected to the system.

The same applies for other corrections too.

I have opened a PR to fix other such broken refs: #551


To allow a camera to be accessible to VLC, the interface can be connected with the `snap connect` command:

Expand All @@ -235,13 +235,13 @@ To access its interface management functions, either search for an installed sna

-->

As you can see the output from `snap connections vlc`, and in the above image, VLC already has access a user's _/home_ directory because the {ref}``home` <interfaces-home-interface>` interface is connected to the system `$HOME` directory. This is an {ref}`automatic connection <explanation-interfaces-interface-auto-connection>`, and is granted to certain interfaces and snaps when an interface provides fundamental functionality, such as VLC accessing your personal video and audio files.
As you can see the output from `snap connections vlc`, and in the above image, VLC already has access a user's _/home_ directory because the [`home`](interfaces-home-interface) interface is connected to the system `$HOME` directory. This is an {ref}`automatic connection <explanation-interfaces-interface-auto-connection>`, and is granted to certain interfaces and snaps when an interface provides fundamental functionality, such as VLC accessing your personal video and audio files.

Refer to {ref}`Interfaces <explanation-interfaces-all-about-interfaces>` for more information.

## Where snaps store data

Most snaps use strict confinement. This isolates both their execution environments and their data from your system (see {ref}`Snap Confinement <explanation-security-snap-confinement>` for further details). A confined snap that needs user-access to files will most likely use the {ref}``home` <interfaces-home-interface>` interface to bridge this confinement gap, allowing you to save and load files from your home directory automatically.
Most snaps use strict confinement. This isolates both their execution environments and their data from your system (see {ref}`Snap Confinement <explanation-security-snap-confinement>` for further details). A confined snap that needs user-access to files will most likely use the [`home`](interfaces-home-interface) interface to bridge this confinement gap, allowing you to save and load files from your home directory automatically.

You can see whether the _home_ interface is being used in the output to `snap connections <snap name>`:

Expand Down
Loading