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

✨ Properly link to CLI docs #120

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

✨ Properly link to CLI docs #120

wants to merge 3 commits into from

Conversation

Zethson
Copy link
Member

@Zethson Zethson commented Aug 8, 2024

I don't like it that we're not linking to the CLI docs for these commands.

What I did here probably doesn't work (syntax)?

Signed-off-by: zethson <lukas.heumos@posteo.net>
@falexwolf
Copy link
Member

Agreed on linking the CLI commands but I think you're syntax wrong. This is the correct syntax: 62510ec

@Zethson
Copy link
Member Author

Zethson commented Aug 8, 2024

Ah yeah, great if that works. Will fix

Signed-off-by: zethson <lukas.heumos@posteo.net>
@Zethson Zethson changed the title ✨ Attempt to link to CLI ✨ Properly link to CLI docs Aug 8, 2024
@falexwolf
Copy link
Member

falexwolf commented Aug 14, 2024

The issue is that formatting the commands as plain links doesn't convey anymore that they're commands.

We'd need to use a Sphinx role to also have syntax highlighting beyond the href.

image

VS

image

@falexwolf falexwolf closed this Aug 24, 2024
@falexwolf falexwolf reopened this Sep 5, 2024
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.

2 participants