Admin

Documentation

Screen guide

Before you start

Use an administrator account with permission to manage this feature. The feature also needs to be enabled for this installation and plan.

Open this feature

Choose a task

Open /docs on your application domain, using the administrator account for this task.
Find the form containing Name, Product Logo, Order. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
Select Save collection. Check the current record, recipients, amount or destination before confirming when those values apply.
If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.

Field	What to enter or choose
Name	Enter the name for this task, using the help or example shown by the form. The form’s example is Stackposts, Replix, Waziper.... Replace it with your own value.
Product Logo	Enter the product logo for this task, using the help or example shown by the form. The form’s example is Logo URL or media path. Replace it with your own value.
Order	Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0.
Status	Choose Public, Draft.
Description	Enter the description for this task, using the help or example shown by the form. The form’s example is Short summary. Replace it with your own value.

Open /docs on your application domain, using the administrator account for this task.
Find the form containing Untitled documentation, Add a short summary. This appears in cards and search results., Start writing your documentation.... Complete the relevant fields using the table below. Fields can appear or change after you select an option.
Select Save documentation. Check the current record, recipients, amount or destination before confirming when those values apply.
If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.

Field	What to enter or choose
Untitled documentation	Required. Enter the untitled documentation for this task, using the help or example shown by the form. The form’s example is Untitled documentation. Replace it with your own value.
Add a short summary. This appears in cards and search results.	Enter the add a short summary. this appears in cards and search results. for this task, using the help or example shown by the form. The form’s example is Add a short summary. This appears in cards and search results.. Replace it with your own value.
Start writing your documentation...	Enter the start writing your documentation... for this task, using the help or example shown by the form. The form’s example is Start writing your documentation.... Replace it with your own value.
Status	Choose Public, Draft.
Collection	Required. Enter the collection for this task, using the help or example shown by the form.
Order	Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 0.

Field descriptions appear beside each task above so that separate forms are not mixed together.

Stay in the same account/workspace and reopen the intended record or result screen.
For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.

Problem	What to check
The screen or action is missing	Check the correct administrator account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint.
A field is rejected	Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice.
A list is empty	Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing.
A request is still pending	Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately.

Role-scoped source references

Pinned commit: 275481cdd3c8519a24c5ecf5cac3e11ceb1708d8

Source-only route information

Method	Source-default route
GET	/docs
GET	/docs/{collectionSlug}
GET	/docs/{collectionSlug}/{pageSlug}
RESOURCE	/admin/documentation
POST	/admin/documentation/list
GET	/admin/documentation/create
GET	/admin/documentation/edit/{id}
POST	/admin/documentation/save
POST	/admin/documentation/reorder
POST	/admin/documentation/duplicate
POST	/admin/documentation/status/{any}
POST	/admin/documentation/destroy
GET	/admin/documentation/collections
POST	/admin/documentation/collections/save
POST	/admin/documentation/collections/destroy

Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source key	Handler
collection_id	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
title	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
content	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
status	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
name	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
logo	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
description	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php
sort_order	modules/AdminDocumentation/app/Http/Controllers/AdminDocumentationController.php