Skip to content

VPS-23/write-basic-tutorial-documentation #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
harbassan wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −0
Draft

VPS-23/write-basic-tutorial-documentation #354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions wiki/Tutorial/Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +3
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.

> [!NOTE]
> An example informational callout.
Copy link

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.

> [!WARNING]
> An example warning callout. Pay special attention to these, as they may detail edge cases or limitations you need to be aware of.


Loading