Consistency in Code Snippet Formats

[Selkubi]

In the repository, there is an inconsistency in the formatting of code snippets between sections. Specifically:

1. In the "Requesting a VPS" section:

   • Code snippets are provided separately for Ubuntu and RedHat systems.

2. In the "Configure SSH Tunneling" section:

   • Code snippets are written in Bash but use inconsistent formatting:
     • Some lines begin with the $ sign to indicate a shell prompt.
     • Other lines omit the $ sign entirely.

This inconsistency can cause confusion for readers, as it mixes conventions and does not clearly distinguish between command input and expected output.

Proposed Solution

To address this, we could establish a code snippet syntax guideline for the repository.

1. Command Prompt Indicator:

   • Use the $ sign consistently in all code snippets to indicate a shell prompt or not use it at all for easy of copying.

2. Cross-Platform Snippets:

   • Use consistent formatting for snippets targeting different systems (e.g., Ubuntu and RedHat). If a previous step has Ubuntu prompt, we should assume that the user will keep using Ubuntu in the next step.

I propose the following action items

1. Decide on the formatting rules for command snippets.
2. Update the code snippets in the "Configure SSH Tunneling" section to match the agreed guidelines.
3. Add a contributing guide or style guide outlining these rules for future contributions.