Skip to content

Commit

Permalink
feat(docs): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
prplwtf committed Nov 14, 2023
1 parent 38d7282 commit 74fa5b4
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 4 deletions.
14 changes: 14 additions & 0 deletions docs/pages/about/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Changelog
<h4 class="fw-light">List of changes, improvements and bugfixes per version release</h4><br/>

<h4 class="text-warning fw-bold">Pre-releases</h4>
<div class="row row-cols-1 row-cols-lg-3 align-items-stretch g-4 py-3 pt-3">
<div class="col">
<a href="?page=about/changelog/alpha-3ZX" class="link-underline-opacity-0 link-underline">
<div class="card card-cover h-100 overflow-hidden rounded-4 bg-dark bg-hover-dark">
<div class="d-flex flex-column h-100 p-4 text-shadow-1">
<h3 class="fw-bolder">alpha-3ZX <span class="badge bg-warning border border-warning rounded-pill text-dark">Unstable</span></h3>
</div>
</div>
</a>
</div>
</div>
<br/>

<h4 class="text-primary fw-bold">Supported releases</h4>
<div class="row row-cols-1 row-cols-lg-3 align-items-stretch g-4 py-3 pt-3">
<div class="col">
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/about/changelog/__template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<span class="badge bg-success-subtle border border-success-subtle text-success-emphasis rounded-pill"><i class="bi bi-check-lg"></i> Latest</span>
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-bug-fill"></i> Supported</span>
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-hash"></i> Supported</span>
<span class="badge bg-secondary-subtle border border-secondary-subtle text-secondary-emphasis rounded-pill"><i class="bi bi-x-lg"></i> Unsupported</span>
<span class="badge bg-warning-subtle border border-warning-subtle text-warning-emphasis rounded-pill"><i class="bi bi-x-lg"></i> Pre-release</span>
# version-name
<br/>

Expand Down
18 changes: 18 additions & 0 deletions docs/pages/about/changelog/alpha-3ZX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<span class="badge bg-warning-subtle border border-warning-subtle text-warning-emphasis rounded-pill"><i class="bi bi-binoculars-fill"></i> Pre-release</span>
# alpha-3ZX
<br/>

#### Changes
- New installation timestamp placeholder: `^#timestamp#^`
- New public directory placeholder: `^#publicpath#^`
- Add website button icon for Patreon, Reddit and Trello.

<br/>

#### Bugfixes
- Incorrect website button icon for Discord extension website links.

<br/>

#### Breaking Changes
-
2 changes: 1 addition & 1 deletion docs/pages/about/changelog/alpha-IPS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<span class="badge bg-success-subtle border border-success-subtle text-success-emphasis rounded-pill"><i class="bi bi-check-lg"></i> Latest</span>
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-bug-fill"></i> Supported</span>
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-hash"></i> Supported</span>
# alpha-IPS
<br/>

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/about/changelog/alpha-XT1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-bug-fill"></i> Supported</span>
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"><i class="bi bi-hash"></i> Supported</span>
# alpha-XT1
<br/>

Expand Down
8 changes: 7 additions & 1 deletion docs/pages/documentation/placeholders.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@ The path to the host's Pterodactyl installation folder. You should always use th
`^#datapath#^`\
Path to your extension's data directory. To keep your extension from breaking in the future, it's always a good idea to use this placeholder instead of guessing.

`^#publicpath#^` <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Developer branch</span>\
Path to your extension's public data directory. This directory is exposed to the internet, so don't store keys or sensitive information in there! To keep your extension from breaking in the future, it's always a good idea to use this placeholder instead of guessing.

`^#installmode#^`\
Information about how the extension was installed. Is "normal" when the extension has been installed normally and "developer" when the extension was installed through developer commands.

`^#blueprintversion#^`\
Blueprint version that installed/built your extension.
Blueprint version that installed/built your extension.

`^#timestamp#^` <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Developer branch</span>\
Timestamp of when your extension started installation, specifically the timestamp of when Blueprint started applying extension placeholders.

0 comments on commit 74fa5b4

Please sign in to comment.