Appearance
A template for every plugin
Create future Auralis product collections from the same reusable structure, then replace its writing prompts with the actual product's features, API, and verified release details.
Create a collection in Studio
- Start Auralis Studio and choose New product beside Your library.
- Enter the product name and a stable page address, such as
my-plugin. - Choose Plugin documentation · 10 pages as the starting point.
- Add a short product description and choose Create collection.
- Select each page from its collection and fill it in with the visual editor.
Blank collection · 1 page remains available when a full plugin structure is unnecessary.
Included pages
| Section | Page | What to write |
|---|---|---|
| Getting started | Overview | Problem solved, included features, requirements, product and support links. |
| Getting started | Installation | Exact package, tested versions/platforms, enabling, and a visible installation check. |
| Getting started | Quick start | One reproducible workflow with real names, values, and an observable result. |
| Guides and reference | Core concepts | Ownership, lifetime, important defaults, and limits. |
| Guides and reference | Blueprint guide | Actual node names/categories, pins, return values, and failure cases. |
| Guides and reference | C++ guide | Module dependencies, public headers, minimal integration, and cleanup. |
| Guides and reference | Settings | Exact editor path, defaults, effects, and when changes take effect. |
| Release and support | Troubleshooting | Symptom, cause, action, and expected result. |
| Release and support | Changelog | Released changes, compatibility evidence, and upgrade steps. |
| Release and support | Support | Verified channel, useful report details, and example-project availability. |
Product names and the description are inserted automatically. Page files, section navigation, and the product card are generated together. Add product-specific guides with New page; for example, Register System adds scopes, duplicate behavior, actor queries, and migration.
DRAFTS ARE NOT PRIVATE
Template pages start with Include in site search disabled. They still have direct URLs and navigation entries, and a site build can publish them. Replace the authoring prompts and review every page before uploading or publishing a build. Excluding a page from search or navigation is not access control.
Review and publish
In Page settings, enable Include in site search after reviewing a page. Use Show in navigation, Section, and Move up/down to organize the collection. Product settings controls its name, description, category, and version badge.
Use Callout for information, tip, warning, and danger boxes. Choose Save page, then Rebuild site to check the local result. Publishing to GitHub remains a separate step.
Evidence before claims
Record supported engine/platform versions from actual test results. Distinguish build checks, automation, visual testing, and performance measurements. An engine version in a descriptor is not enough to claim that every feature was tested.
Use actual released headers and node names in examples. Explain threading, networking, ownership, persistence, and separately distributed example content where relevant. Remove template prompts and unverified claims before publishing.
See Auralis Register System for a filled-out collection and Using Auralis Studio for editor controls.