Skip to content

How to navigate the VeloxOS Wiki

Here are some tips to help you get the most out of the VeloxOS wiki, including features that are easy to miss.

  • Contribute Feedback: If you have a suggestion or find an error in the documentation, you can help us improve!
    • At the bottom of each page, you’ll find an Edit page button that takes you directly to the corresponding file on GitHub where you can propose changes.
    • Alternatively, you can open a new issue on our GitHub repository.
  • Search is Your First Tool: Use the search bar at the top of the page to quickly find information related to your configuration, Nix flakes, or system packages.
  • Navigate with the Sidebars:
    • The left sidebar is scrollable and contains the main table of contents for the entire documentation. Use it to explore different sections.
    • Don’t forget the right sidebar. It often contains a helpful overview of the current page’s sections, allowing for quick navigation.
  • Useful Features:
    • Code Blocks: All code blocks have a Copy to clipboard button on the top-right for easy copying. This is especially useful for copying Nix configuration snippets or terminal commands.
    • Hyperlinks: Keep an eye out for underlined and/or colored text. These are links to other parts of the wiki or external resources for further reading.
  • Pay close attention to notes, tips, warnings, and cautions. They contain important information that can help you avoid common pitfalls and manage your system generations safely.