Skip to content

Commit

Permalink
feat /docs: remove old "new in beta-whatever" and document upcoming…
Browse files Browse the repository at this point in the history
… feature
  • Loading branch information
prplwtf committed Aug 19, 2024
1 parent b411ee9 commit 5f12dc1
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
23 changes: 16 additions & 7 deletions docs/pages/documentation/$blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ The BlueprintExtensionLibrary is automatically imported to dashboard wrappers, a

### **Functions**

##### Databasing <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Universal</span>
##### Databasing <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Admin <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Client <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Console <i class="bi bi-check"></i></span>
`dbGet(table, record)`\
Fetch a record from the database.

`dbSet(table, record, value)`\
Set a database record.

`dbForget(table, record)` <tag type="new" content="beta-F248"/></tag>\
`dbForget(table, record)`\
Delete/forget a database record.

<br/>

##### Notifications <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill">Admin</span>
##### Notifications <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Admin <i class="bi bi-check"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">Client <i class="bi bi-x"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">Console <i class="bi bi-x"></i></span>
`notify(text)`\
Allows you to show notifications on the admin panel. Appears on next reload.

Expand All @@ -40,7 +40,7 @@ Allows you to show notifications on the admin panel after a delay. This behaves

<br/>

##### Files <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Universal</span>
##### Files <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Admin <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Client <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Console <i class="bi bi-check"></i></span>
`fileRead(path)`\
Returns the contents of the file defined in `path`.

Expand All @@ -52,6 +52,15 @@ Removes the file defined in `path` from the filesystem.

<br/>

##### Extensions <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Universal</span>
`extension(identifier)` <tag type="new" content="beta-A428"/></tag>\
Returns true if an extension with the identifier defined in `identifier` is installed, otherwise returns false.
##### Extensions <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Admin <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Client <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Console <i class="bi bi-check"></i></span>
`extension(identifier)`\
Returns true if an extension with the identifier defined in `identifier` is installed, otherwise returns false.

<br/>

##### Import <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Admin <i class="bi bi-check"></i></span> <span class="badge bg-primary-subtle text-primary-emphasis rounded-pill">Client <i class="bi bi-check"></i></span> <span class="badge bg-secondary-subtle text-secondary-emphasis rounded-pill opacity-50">Console <i class="bi bi-x"></i></span>
`importStylesheet(url)` <tag type="new" content="beta-2024-08"/></tag>\
Returns a HTML link tag importing the specified stylesheet with additional URL params to avoid issues with stylesheet cache.

`importScript(url)` <tag type="new" content="beta-2024-08"/></tag>\
Returns a HTML script tag importing the specified script with additional URL params to avoid issues with script cache.
2 changes: 1 addition & 1 deletion docs/pages/documentation/confyml.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Path to your data directory. These are private extension-specific files which yo
`public`\
Path to your public directory. All files in this folder are available publicly and can be seen by anyone, so don't store any secrets or keys here.

`console` <tag type="new" content="beta-F248"/></tag>\
`console` \
Path to your console directory which allows for creating Artisan commands and scheduling them. [Learn more](?page=documentation/consoleyml) about the console API.

<br/>
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/documentation/flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Skip rebuilding panel assets when installing your extension through developer co
`developerForceMigrate` <tag type="new" content="beta-A428"/></tag>\
Forcefully migrate the database non-interactively when installing your extension through developer commands.

`developerKeepApplicationCache` <tag type="new" content="beta-F248"/></tag>\
`developerKeepApplicationCache` \
Prevents Blueprint from flushing the application's cache when building extensions through developer commands.

`developerEscalateExportScript` <tag type="new" content="beta-F248"/></tag>\
`developerEscalateExportScript` \
Allows you to run export scripts with root permissions instead of running them through the webserver user.

0 comments on commit 5f12dc1

Please sign in to comment.