Documentation improvements for 1.0 release

[FrankRay78]

The following PR spectreconsole/examples#1 should be reviewed/merged at the same time as this one.

---

fixes #1602

• I have read the Contribution Guidelines
• I have commented on the issue above and discussed the intended changes
• A maintainer has signed off on the changes and the issue was assigned to me
• All newly added code is adequately covered by tests
• All existing tests are still running without errors
• The documentation was modified to reflect the changes OR no documentation changes are required.

Changes

• Fix broken documentation build introduced by Razor change (See: Possible verbatim string literal regression dotnet/razor#10568 for breaking Razor change)
• Fixed broken links to the examples project from preparation for 1.0 (See: Broken Documentation Link to Dependency Injection Example (and possible documentation improvements) #1602 (comment))
• Rewrote the CommandApp Dependency Injection section for better clarity and readability.

---

Please upvote 👍 this pull request if you are interested in it.

[FrankRay78]

@patriksvensson I've addressed your earlier review comments and rebased against main, fixing conflicts. This PR is now ready for another review +/ merging.

IMPORTANT: The following PR spectreconsole/examples#1 should be reviewed/merged at the same time as this one.