Skip to content

Conversation

@sboldyreva
Copy link
Collaborator

This pull request introduces improvements to enhance the user experience when working with code blocks and documentation navigation.

  • Code blocks now include a copy button to copy commands.
    • What SVGs to use? I used GitHub's
    • I couldn't manage to make code blocks like this by default, requires manually wrapping every time
  • Added code tabs to allow more compact and structured instructions by combining related variants (e.g. rpm/deb based) in a single place.
    • Issue: I couldn't make code tabs to allow aligning them with the text, there seem to be sort of indentation issue inside code tabs. (screenshot 2)
    • What SVGs to use? I used GitHub's
  • Breadcrumbs are now clickable, with support for parent, improving page navigation and context visibility.
    • Issue: It seems that extracting a heading for the breadcrumb from the file doesn't work for the parent level.

The code was written with the help of AI, so I’d appreciate a careful code review and general feedback on the code and the ideas behind these changes is welcome.

We could also consider upgrating vue to use and customize plugins: copy-code, tabs

tuxcare-feature-1
tuxcare-feature-2

Copy link
Collaborator

@yel-hadd yel-hadd left a comment

Choose a reason for hiding this comment

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

Looks good, thank you for your contribution.

I will implement the same improvements on our other documentation websites.

@yel-hadd yel-hadd marked this pull request as ready for review May 27, 2025 12:10
@yel-hadd yel-hadd merged commit 2f2002d into cloudlinux:master May 27, 2025
@sboldyreva sboldyreva deleted the features branch May 28, 2025 16:18
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