Conversation
There was a problem hiding this comment.
Pull request overview
Adds an initial “Introduction” page under the wiki Tutorial section to start end-user tutorial documentation for VPS.
Changes:
- Created
wiki/Tutorial/Introduction.mdwith an intro blurb. - Added example NOTE/WARNING admonition callouts for the tutorial.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,11 @@ | |||
| # Introduction | |||
|
|
|||
| Hello, welcome to VPS! This user tutorial will cover what exactly this thing is and how you can leverage all of its capabilities. The tutorial is split across a few pages, each for a related set of functionality, and each page is sectioned appropriately. Additionally, we'll use various callouts throughout the documentation wherever we want to bring special attention to something. Hopefully, this makes it easy to find the information you need. | |||
There was a problem hiding this comment.
The introduction says the tutorial is split across multiple pages, but currently this is the only file under wiki/Tutorial/. Either add the other pages/links in this PR or reword this to avoid implying existing pages that aren't present yet.
| Hello, welcome to VPS! This user tutorial will cover what exactly this thing is and how you can leverage all of its capabilities. The tutorial is split across a few pages, each for a related set of functionality, and each page is sectioned appropriately. Additionally, we'll use various callouts throughout the documentation wherever we want to bring special attention to something. Hopefully, this makes it easy to find the information you need. | ||
|
|
||
| > [!NOTE] | ||
| > An example informational callout. |
There was a problem hiding this comment.
There is trailing whitespace at the end of this line, which tends to create noisy diffs and can trip markdown linters/editors. Please remove the extra space after the period.
| # Introduction | ||
|
|
||
| Hello, welcome to VPS! This user tutorial will cover what exactly this thing is and how you can leverage all of its capabilities. The tutorial is split across a few pages, each for a related set of functionality, and each page is sectioned appropriately. Additionally, we'll use various callouts throughout the documentation wherever we want to bring special attention to something. Hopefully, this makes it easy to find the information you need. |
There was a problem hiding this comment.
The PR description still contains the default template placeholders (Issue/Solution sections are empty). Please update the PR description to briefly state what documentation was added/changed and what remains to be done (if anything).
Issue
A clear and concise description of what the issue is
Solution
A clear and concise description of what the solution is
Risk
None.
Checklist