Add Module level docs

[G8XSU]

Note that crate level doc is mostly a placeholder, more details regarding usage to be documented pre-release.

[tnull]

Even if we don't want to add a full usage example now, it would be great to spend some words on how we imagine this crate to be used and/or to give a bit more context.

E.g.: What is VSS? Where can we learn more?

[tnull]

Suggested change

	/// Implements a thin-client [[`VssClient`]] to access a hosted instance of Versioned Storage Service (VSS).
	/// Implements a thin-client [`VssClient`] to access a hosted instance of Versioned Storage Service (VSS).

[G8XSU]

I wanted those brackets to be there, otherwise the sentence seems a bit confusing.
"Implements a thin-client VssClient to access a hosted instance of Versioned Storage Service (VSS)."

[tnull]

Ah, but for that you might want to use parentheses rather than brackets?

[G8XSU]

i am baffled that we have to discuss this.
But i think use of brackets is correct here.

• Brackets are used to enclose additional information or comments within a sentence. They are often used for clarification, to add explanations, or to provide context to a particular word or phrase.

in this case, it is providing additional information in the context of the thin-client implementation.

[tnull]

Okay, nevermind. Just looks a bit odd in the rendered docs.

[G8XSU]

idk, brackets don't look any different in rendered docs than parenthesis. both remain the same.

[jkczyz]

Brackets are definitely not normally used like this and honestly I thought this was a copy-paste and/or text editor mistake. Where does your reference come from?

Most English writing style guides limit brackets to very specific uses (e.g., https://apastyle.apa.org/learn/faqs/use-brackets). I'd rather use parentheses instead for consistency with these guidelines and all our other docs.

[G8XSU]

Not that it has to be a source of truth but I repeatedly asked chatgpt for brackets vs parenthesis for this documentation.
Here's what it had to say:

In some cases, parentheses can also be used to enclose additional information within a sentence. However, in the context of your original sentence, using square brackets [ ] is more appropriate and common for several reasons:

• Clarity: Square brackets are commonly used to add clarifications, annotations, or meta-information within a sentence. They stand out more and make it clear that the enclosed text is an additional comment or detail.

• Technical Context: In many technical contexts, such as programming or documentation, square brackets are often used to indicate optional or placeholder elements, as in [VssClient]. This is a familiar convention in these fields.

While it's not necessarily incorrect to use parentheses in this context, the convention of using square brackets [ ] for annotations or optional elements is more common, especially in technical writing or when providing additional information about a specific term.

But my overarching point is that neither of them is strictly right or wrong in this context. I guess chatgpt seems to agree.

[jkczyz]

The first point seems to mostly agree with the style guide that I cited other than the the vague "add clarification". Square brackets are used for very specific things as noted there.

The second point doesn't agree with your use. It's talking about optional parameters to commands where the convention is to use square brackets to indicate the optionality. VssClient doesn't fit that description.

Why don't we just avoid the issue entirely by using a normal link?

Implements a [thin-client](VssClient) to access a hosted instance of Versioned Storage Service (VSS).

[G8XSU]

Replaced with '()'