Improvements to the documentation

[zanieb]

No description provided.

[eth3lbert]

Suggested change

	$ # Create a virtual environment at `.venv`
	uv venv
	$ # Create a virtual environment at `.venv`
	$ uv venv

[zanieb]

@eth3lbert thank you! I fixed those, though I mostly tried to move content outside of the codeblock.

[eth3lbert]

@zanieb You should probably also add a $ at the beginning of # comments.

While serving this locally, I noticed it transforms the code block into the following on the website (http://localhost:8000/uv/guides/integration/alternative-indexes/#using-keyring):

<code tabindex="0"><a id="__codelineno-1-1" name="__codelineno-1-1" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-1"></a><span class="gp"># </span>Pre-install<span class="w"> </span>keyring<span class="w"> </span>and<span class="w"> </span>the<span class="w"> </span>Artifacts<span class="w"> </span>plugin<span class="w"> </span>from<span class="w"> </span>the<span class="w"> </span>public<span class="w"> </span>PyPI
<a id="__codelineno-1-2" name="__codelineno-1-2" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-2"></a><span class="gp">$ </span>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>keyring<span class="w"> </span>--with<span class="w"> </span>artifacts-keyring
<a id="__codelineno-1-3" name="__codelineno-1-3" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-4"></a><span class="gp"># </span>Enable<span class="w"> </span>keyring<span class="w"> </span>authentication
<a id="__codelineno-1-5" name="__codelineno-1-5" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-5"></a><span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">UV_KEYRING_PROVIDER</span><span class="o">=</span>subprocess
<a id="__codelineno-1-6" name="__codelineno-1-6" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-6"></a>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-7"></a><span class="gp"># </span>Configure<span class="w"> </span>the<span class="w"> </span>index<span class="w"> </span>URL<span class="w"> </span>with<span class="w"> </span>the<span class="w"> </span>username
<a id="__codelineno-1-8" name="__codelineno-1-8" href="http://localhost:8000/uv/guides/integration/alternative-indexes/#__codelineno-1-8"></a><span class="gp">$ </span><span class="nb">export</span><span class="w"> </span><span class="nv">UV_EXTRA_INDEX_URL</span><span class="o">=</span>https://VssSessionToken@pkgs.dev.azure.com/<span class="o">{</span>organisation<span class="o">}</span>/<span class="o">{</span>project<span class="o">}</span>/_packaging/<span class="o">{</span>feedName<span class="o">}</span>/pypi/simple/
</code>

And it shows that the # symbol has the gp classname, which could cause issues if copied, as the # would be ignored!

[zanieb]

😭 that's tragic.

[eth3lbert]

Perhaps adding a note to STYLE.md? Alternatively, modify the copy logic to strictly ignore just $, not all go or gp classes.