mag/WMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation updates

Browse Source
This commit is contained in:
Mark Gregory
2026-06-15 08:06:57 +01:00
parent 2a9d25ec18
commit 5aa026d3c6
80 changed files with 591 additions and 2469 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/Documentation/Config/.gitkeep
View File
Modules/Documentation/Config/config.php
-25
View File
@@ -1,25 +0,0 @@
<?php
return [
'name' => 'Documentation',
'route_prefix' => 'documentation',
'middleware' => ['web', 'auth'],
'storage_disk' => env('DOCUMENTATION_DISK', 'public'),
'upload_path' => env('DOCUMENTATION_UPLOAD_PATH', 'documentation'),
'allowed_upload_mimes' => [
'pdf', 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', 'txt', 'md', 'csv', 'png', 'jpg', 'jpeg', 'webp',
],
'max_upload_kb' => 20480,
'import_markdown_attachments' => true,
'max_markdown_import_bytes' => 1048576,
'editor' => [
'markdown_toolbar' => true,
'supports_code_blocks' => true,
'supports_tables' => true,
],
'statuses' => [
'draft' => 'Draft',
'published' => 'Published',
'archived' => 'Archived',
],
];
Modules/Documentation/Console/.gitkeep
View File
Modules/Documentation/Database/Migrations/.gitkeep
View File
Modules/Documentation/Database/Migrations/2026_06_12_000000_create_documentation_categories_table.php
-35
View File
@@ -1,35 +0,0 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration {
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('documentation_categories', function (Blueprint $table): void {
$table->id();
$table->string('name')->comment('Human-readable category name.');
$table->string('slug')->unique()->comment('URL-safe category identifier.');
$table->string('icon')->nullable()->comment('Optional UI icon class or key.');
$table->string('colour', 32)->default('emerald')->comment('Display colour token.');
$table->text('description')->nullable()->comment('Category description shown in the documentation UI.');
$table->unsignedInteger('sort_order')->default(0)->index()->comment('Manual display order.');
$table->boolean('is_active')->default(true)->index()->comment('Whether the category is visible and usable.');
$table->foreignId('created_by')->nullable()->constrained('users')->nullOnDelete()->comment('User that created the category.');
$table->foreignId('updated_by')->nullable()->constrained('users')->nullOnDelete()->comment('Last user that updated the category.');
$table->timestamps();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('documentation_categories');
}
};
Modules/Documentation/Database/Migrations/2026_06_12_000010_create_documentation_documents_table.php
-47
View File
@@ -1,47 +0,0 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration {
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('documentation_documents', function (Blueprint $table): void {
$table->id();
$table->foreignId('documentation_category_id')->nullable()->constrained('documentation_categories')->nullOnDelete()->comment('Optional owning documentation category.');
$table->string('title')->comment('Document title.');
$table->string('slug')->unique()->comment('URL-safe document identifier.');
$table->string('summary', 500)->nullable()->comment('Short document summary.');
$table->longText('body')->nullable()->comment('Full document body, markdown or HTML-safe text depending on editor implementation.');
$table->string('status', 32)->default('draft')->index()->comment('Workflow status: draft, published, or archived.');
$table->boolean('is_featured')->default(false)->index()->comment('Whether this document is highlighted on the documentation dashboard.');
$table->string('version', 50)->default('1.0.0')->comment('Document version label.');
$table->string('reference', 100)->nullable()->index()->comment('Optional business reference or document code.');
$table->string('attachment_disk')->nullable()->comment('Storage disk used for the attached file.');
$table->string('attachment_path')->nullable()->comment('Storage path for the attached file.');
$table->string('attachment_name')->nullable()->comment('Original uploaded file name.');
$table->string('attachment_mime')->nullable()->comment('Uploaded file MIME type.');
$table->unsignedBigInteger('attachment_size')->nullable()->comment('Uploaded file size in bytes.');
$table->timestamp('published_at')->nullable()->index()->comment('Date/time the document was published.');
$table->foreignId('created_by')->nullable()->constrained('users')->nullOnDelete()->comment('User that created the document.');
$table->foreignId('updated_by')->nullable()->constrained('users')->nullOnDelete()->comment('Last user that updated the document.');
$table->timestamps();
$table->softDeletes();
$table->index(['status', 'is_featured']);
$table->index(['documentation_category_id', 'status']);
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('documentation_documents');
}
};
Modules/Documentation/Database/Migrations/2026_06_12_000020_create_documentation_attachments_table.php
-35
View File
@@ -1,35 +0,0 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration {
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('documentation_attachments', function (Blueprint $table): void {
$table->id();
$table->foreignId('documentation_document_id')->constrained('documentation_documents')->cascadeOnDelete()->comment('Owning documentation document.');
$table->string('disk')->comment('Storage disk used for the uploaded attachment.');
$table->string('path')->comment('Storage path for the uploaded attachment.');
$table->string('original_name')->comment('Original uploaded file name.');
$table->string('mime_type')->nullable()->comment('Uploaded file MIME type.');
$table->unsignedBigInteger('size')->nullable()->comment('Uploaded file size in bytes.');
$table->foreignId('uploaded_by')->nullable()->constrained('users')->nullOnDelete()->comment('User that uploaded the attachment.');
$table->timestamps();
$table->index(['documentation_document_id', 'created_at']);
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('documentation_attachments');
}
};
Modules/Documentation/Database/Seeders/.gitkeep
View File
Modules/Documentation/Database/Seeders/DocumentationDatabaseSeeder.php
-21
View File
@@ -1,21 +0,0 @@
<?php
namespace Modules\Documentation\Database\Seeders;
use Illuminate\Database\Seeder;
use Illuminate\Database\Eloquent\Model;
class DocumentationDatabaseSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
Model::unguard();
// $this->call("OthersTableSeeder");
}
}
Modules/Documentation/Database/factories/.gitkeep
View File
Modules/Documentation/Helpers/.gitkeep
View File
Modules/Documentation/Helpers/Helper.php
-12
View File
@@ -1,12 +0,0 @@
<?php
use Modules\Documentation\Support\ModuleInfo;
if (! function_exists('documentation_feature_enabled')) {
/**
* Check if a feature is enabled in the config.
*/
function documentation_feature_enabled(string $key): bool
{
return (bool) config(ModuleInfo::nameLower().".features.{$key}", false);
}
}
Modules/Documentation/Http/Controllers/.gitkeep
View File
Modules/Documentation/Http/Middleware/.gitkeep
View File
Modules/Documentation/Http/Requests/.gitkeep
View File
Modules/Documentation/Models/.gitkeep
View File
Modules/Documentation/Providers/.gitkeep
View File
Modules/Documentation/Providers/DocumentationServiceProvider.php
-155
View File
@@ -1,155 +0,0 @@
<?php
namespace Modules\Documentation\Providers;
use Illuminate\Support\ServiceProvider;
use Illuminate\Database\Eloquent\Factory;
use Illuminate\Support\Facades\File;
use Modules\Documentation\Support\ModuleInfo;
use Config;
class DocumentationServiceProvider extends ServiceProvider
{
/**
* @var string $moduleName
*/
protected string $moduleName = 'Documentation';
/**
* @var string $moduleNameLower
*/
protected string $moduleNameLower = 'documentation';
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides():array
{
return [];
}
/**
* Boot the application events.
*
* @return void
*/
public function boot() : void
{
$this->registerTranslations();
$this->registerConfig();
$this->registerViews();
$this->registerHelpers();
$this->registerCommands();
$this->loadMigrationsFrom(module_path(ModuleInfo::name(), 'Database/Migrations'));
}
/**
* Register the service provider.
*
* @return void
*/
public function register(): void
{
$this->app->register(RouteServiceProvider::class);
}
/**
* Register the helpers.
*
* @return void
*/
protected function registerHelpers(): void
{
foreach (glob(__DIR__.'/../Helpers/*.php') as $filename) {
require_once $filename;
}
}
/**
* Dynamically Register Commands.
*
* @return void
*/
public function registerCommands(): void
{
if (!$this->app->runningInConsole()) {
return;
}
$commandPath = __DIR__ . '/../Console';
$commands = collect(File::allFiles($commandPath))
->map(function ($file) {
$class = 'Modules\\' . $this->moduleName . '\\Console\\' . $file->getFilenameWithoutExtension();
return $class;
})
->filter(function ($class) {
return class_exists($class);
})
->values()
->all();
$this->commands($commands);
}
/**
* Register config.
*
* @return void
*/
protected function registerConfig(): void
{
$this->publishes([
module_path(ModuleInfo::name(), 'Config/config.php') => config_path( ModuleInfo::nameLower(). '.php'),
], 'config');
$this->mergeConfigFrom(
module_path(ModuleInfo::name(), 'Config/config.php'), ModuleInfo::nameLower()
);
}
/**
* Register views.
*
* @return void
*/
public function registerViews(): void
{
$viewPath = resource_path('views/modules/' . ModuleInfo::nameLower());
$sourcePath = module_path(ModuleInfo::name(), 'Resources/views');
$this->publishes([
$sourcePath => $viewPath
], ['views', ModuleInfo::nameLower() . '-module-views']);
$this->loadViewsFrom(array_merge($this->getPublishableViewPaths(), [$sourcePath]), ModuleInfo::nameLower());
}
/**
* Register translations.
*
* @return void
*/
public function registerTranslations(): void
{
$langPath = resource_path('lang/modules/' . ModuleInfo::nameLower());
if (is_dir($langPath)) {
$this->loadTranslationsFrom($langPath, ModuleInfo::nameLower());
} else {
$this->loadTranslationsFrom(module_path(ModuleInfo::name(), 'Resources/lang'), ModuleInfo::nameLower());
}
}
/**
* Regsiter View Paths
* @return array
*/
private function getPublishableViewPaths(): array
{
$paths = [];
foreach (Config::get('view.paths') as $path) {
if (is_dir($path . '/modules/' . ModuleInfo::nameLower())) {
$paths[] = $path . '/modules/' . ModuleInfo::nameLower();
}
}
return $paths;
}
}
Modules/Documentation/Resources/assets/.gitkeep
View File
Modules/Documentation/Resources/assets/js/app.js
View File
Modules/Documentation/Resources/assets/sass/app.scss
View File
Modules/Documentation/Resources/lang/.gitkeep
View File
Modules/Documentation/Resources/views/.gitkeep
View File
Modules/Documentation/Resources/views/categories/create.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Create Category')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Create category',
'subtitle' => 'Add a professional grouping for documents and operational knowledge.',
@@ -15,4 +16,5 @@
</form>
</div>
</section>
</div>
@endsection
Modules/Documentation/Resources/views/categories/edit.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Edit Category')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Edit category',
'subtitle' => 'Update category naming, ordering, visibility, and presentation metadata.',
@@ -15,4 +16,5 @@
</form>
</div>
</section>
</div>
@endsection
Modules/Documentation/Resources/views/categories/index.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Document Categories')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Document categories',
'subtitle' => 'Organise documents by policy, process, onboarding, operational support, or technical area.',
@@ -54,4 +55,5 @@
<div style="margin-top:18px;">{{ $categories->links() }}</div>
</div>
</section>
</div>
@endsection
Modules/Documentation/Resources/views/documents/create.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Create Document')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Create document',
'subtitle' => 'Add a controlled document, guide, policy, SOP, upload, or operational note.',
@@ -15,4 +16,5 @@
</form>
</div>
</section>
</div>
@endsection
Modules/Documentation/Resources/views/documents/edit.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Edit Document')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Edit document',
'subtitle' => 'Maintain document metadata, workflow status, version and attachment details.',
@@ -22,4 +23,5 @@
@method('DELETE')
</form>
@endforeach
</div>
@endsection
Modules/Documentation/Resources/views/documents/index.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', 'Documentation')
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => 'Documentation Centre',
'subtitle' => 'Create, control, publish, and archive operational documents from a clean professional register.',
@@ -89,4 +90,5 @@
<div style="margin-top:18px;">{{ $documents->links() }}</div>
</div>
</section>
</div>
@endsection
Modules/Documentation/Resources/views/documents/show.blade.php
+2
View File
@@ -3,6 +3,7 @@
@section('title', $document->title)
@section('content')
<div class="doc-page">
@include('documentation::partials.hero', [
'title' => $document->title,
'subtitle' => $document->summary ?: 'Controlled documentation record with versioning, attachments and Markdown rendering.',
@@ -50,4 +51,5 @@
</div>
</section>
@endif
</div>
@endsection
Modules/Documentation/Resources/views/layouts/master.blade.php
+504 -72
View File
@@ -6,104 +6,536 @@
<title>{{ trim($__env->yieldContent('title', 'Documentation')) }} - {{ config('app.name', 'Laravel') }}</title>
<style>
:root {
--doc-ink: #10231f;
--doc-muted: #64748b;
--doc-line: #dbe7e2;
--doc-ink: #18181b;
--doc-muted: #71717a;
--doc-line: #e4e4e7;
--doc-panel: #ffffff;
--doc-soft: #f5faf8;
--doc-brand: #0f766e;
--doc-brand-dark: #115e59;
--doc-accent: #16a34a;
--doc-danger: #b91c1c;
--doc-warning: #b45309;
--doc-soft: #f4f4f5;
--doc-brand: #2563eb;
--doc-brand-dark: #1d4ed8;
--doc-accent: #059669;
--doc-danger: #dc2626;
--doc-warning: #d97706;
--doc-radius: 22px;
--doc-shadow: 0 24px 70px rgba(15, 35, 31, .12);
--doc-shadow: 0 18px 55px rgba(15, 23, 42, .10);
}
html.dark {
--doc-ink: #f4f4f5;
--doc-muted: #a1a1aa;
--doc-line: #3f3f46;
--doc-panel: #18181b;
--doc-soft: #09090b;
--doc-shadow: 0 18px 55px rgba(0, 0, 0, .28);
}
body.documentation-module {
margin: 0;
background: linear-gradient(135deg, #eef8f3 0%, #f8fafc 45%, #ecfdf5 100%);
background: #ffffff;
color: var(--doc-ink);
font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
min-height: 100vh;
}
.doc-shell { max-width: 1240px; margin: 0 auto; padding: 28px 20px 56px; }
html.dark body.documentation-module {
background: #09090b;
}
.doc-shell {
max-width: 1800px;
margin: 0 auto;
padding: 0;
}
.doc-page {
margin: 0 auto;
max-width: 1800px;
padding: 0;
display: grid;
gap: 1.5rem;
}
.doc-hero-wrap {
overflow: hidden;
border: 1px solid var(--doc-line);
border-radius: 1.5rem;
background: var(--doc-panel);
box-shadow: 0 1px 2px rgba(15, 23, 42, .06);
}
.doc-hero {
display: grid; grid-template-columns: 1fr auto; gap: 24px; align-items: center;
padding: 28px; border-radius: 30px; color: #fff;
background: radial-gradient(circle at top left, rgba(255,255,255,.24), transparent 34%), linear-gradient(135deg, #064e3b, #0f766e 52%, #16a34a);
box-shadow: var(--doc-shadow); margin-bottom: 22px;
display: flex;
flex-direction: column;
gap: 1rem;
padding: 1.75rem 1.5rem;
color: #ffffff;
background: linear-gradient(135deg, #020617 0%, #0f172a 48%, #172554 100%);
}
.doc-eyebrow { text-transform: uppercase; font-size: 12px; letter-spacing: .16em; font-weight: 800; opacity: .82; margin: 0 0 10px; }
.doc-hero h1 { margin: 0; font-size: clamp(30px, 5vw, 52px); line-height: .98; letter-spacing: -.04em; }
.doc-hero p { max-width: 720px; margin: 14px 0 0; color: rgba(255,255,255,.84); font-size: 16px; line-height: 1.65; }
.doc-actions { display: flex; flex-wrap: wrap; gap: 10px; margin-top: 20px; }
.doc-hero-row {
display: flex;
flex-direction: column;
gap: 1rem;
}
.doc-hero h1 {
margin: .5rem 0 0;
font-size: clamp(1.875rem, 4vw, 3rem);
line-height: 1;
font-weight: 700;
letter-spacing: -.04em;
}
.doc-eyebrow {
margin: 0;
color: #bfdbfe;
text-transform: uppercase;
font-size: .75rem;
letter-spacing: .28em;
font-weight: 700;
}
.doc-hero p {
max-width: 48rem;
margin: .5rem 0 0;
color: rgba(219, 234, 254, .9);
font-size: .875rem;
line-height: 1.65;
}
.doc-actions {
display: flex;
flex-wrap: wrap;
gap: .5rem;
}
.doc-button {
border: 1px solid transparent; border-radius: 999px; padding: 11px 16px; font-weight: 800; font-size: 14px;
text-decoration: none; display: inline-flex; align-items: center; gap: 8px; cursor: pointer;
border: 1px solid transparent;
border-radius: .75rem;
padding: .625rem .875rem;
font-weight: 700;
font-size: .875rem;
line-height: 1.25rem;
text-decoration: none;
display: inline-flex;
align-items: center;
justify-content: center;
gap: .5rem;
cursor: pointer;
transition: background-color .15s ease, border-color .15s ease, transform .15s ease, box-shadow .15s ease;
}
.doc-button.primary { background: #fff; color: var(--doc-brand-dark); }
.doc-button.secondary { background: rgba(255,255,255,.14); color: #fff; border-color: rgba(255,255,255,.32); }
.doc-button.dark { background: var(--doc-brand); color: #fff; }
.doc-button.light { background: #f8fafc; color: var(--doc-ink); border-color: var(--doc-line); }
.doc-button.danger { background: #fef2f2; color: var(--doc-danger); border-color: #fecaca; padding: 8px 12px; }
.doc-card { background: rgba(255,255,255,.92); border: 1px solid var(--doc-line); border-radius: var(--doc-radius); box-shadow: 0 14px 45px rgba(15,35,31,.08); overflow: hidden; }
.doc-card-header { padding: 20px 22px; border-bottom: 1px solid var(--doc-line); display: flex; align-items: center; justify-content: space-between; gap: 16px; }
.doc-card-body { padding: 22px; }
.doc-grid { display: grid; gap: 18px; }
.doc-grid.stats { grid-template-columns: repeat(4, minmax(0, 1fr)); margin: 22px 0; }
.doc-stat { padding: 20px; }
.doc-stat strong { display:block; font-size: 30px; letter-spacing: -.04em; }
.doc-stat span { color: var(--doc-muted); font-size: 13px; font-weight: 700; text-transform: uppercase; letter-spacing: .08em; }
.doc-table { width: 100%; border-collapse: collapse; }
.doc-table th { text-align: left; font-size: 12px; text-transform: uppercase; letter-spacing: .08em; color: var(--doc-muted); padding: 12px; border-bottom: 1px solid var(--doc-line); }
.doc-table td { padding: 14px 12px; border-bottom: 1px solid #edf3f0; vertical-align: top; }
.doc-table a { color: var(--doc-brand-dark); font-weight: 800; text-decoration: none; }
.doc-badge { display: inline-flex; align-items: center; border-radius: 999px; padding: 5px 10px; font-size: 12px; font-weight: 800; background: #ecfdf5; color: #065f46; border: 1px solid #bbf7d0; }
.doc-badge.draft { background: #f8fafc; color: #475569; border-color: #cbd5e1; }
.doc-badge.archived { background: #fef2f2; color: #991b1b; border-color: #fecaca; }
.doc-form-grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 16px; }
.doc-field.full { grid-column: 1 / -1; }
.doc-label { display: block; font-weight: 800; margin-bottom: 8px; font-size: 14px; }
.doc-input, .doc-select, .doc-textarea {
width: 100%; box-sizing: border-box; border: 1px solid #cbd5e1; border-radius: 14px; padding: 12px 14px;
background: #fff; color: var(--doc-ink); font: inherit;
.doc-button:hover {
transform: translateY(-1px);
}
.doc-textarea { min-height: 360px; line-height: 1.6; resize: vertical; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace; }
.doc-editor { border: 1px solid #cbd5e1; border-radius: 16px; overflow: hidden; background: #fff; }
.doc-editor .doc-textarea { border: 0; border-radius: 0; min-height: 420px; }
.doc-editor-toolbar { display: flex; flex-wrap: wrap; gap: 6px; padding: 10px; background: #f8fafc; border-bottom: 1px solid var(--doc-line); }
.doc-editor-toolbar button { border: 1px solid #cbd5e1; background: #fff; color: var(--doc-ink); border-radius: 10px; padding: 7px 10px; font-weight: 800; cursor: pointer; }
.doc-editor-toolbar button:hover, .doc-editor-toolbar button:focus { border-color: var(--doc-brand); outline: 2px solid rgba(15, 118, 110, .18); }
.editor-help { padding: 0 14px 12px; margin: -4px 0 0; font-size: 13px; }
.doc-error { color: var(--doc-danger); font-size: 13px; margin-top: 6px; }
.doc-alert { border-radius: 16px; padding: 14px 16px; background: #ecfdf5; color: #065f46; border: 1px solid #bbf7d0; margin-bottom: 18px; font-weight: 700; }
.doc-filter { display: grid; grid-template-columns: 1fr 180px 220px auto; gap: 12px; margin-bottom: 18px; }
.doc-content { line-height: 1.75; font-size: 16px; }
.doc-content h1, .doc-content h2, .doc-content h3 { line-height: 1.2; letter-spacing: -.025em; margin: 1.4em 0 .55em; }
.doc-button.primary,
.doc-button.dark {
background: #2563eb;
color: #ffffff;
border-color: #2563eb;
}
.doc-button.primary:hover,
.doc-button.dark:hover {
background: #1d4ed8;
border-color: #1d4ed8;
}
.doc-button.secondary {
background: rgba(255, 255, 255, .10);
color: #ffffff;
border-color: rgba(255, 255, 255, .22);
}
.doc-button.secondary:hover {
background: rgba(255, 255, 255, .16);
}
.doc-button.light {
background: #f8fafc;
color: #18181b;
border-color: #d4d4d8;
}
html.dark .doc-button.light {
background: #09090b;
color: #f4f4f5;
border-color: #3f3f46;
}
.doc-button.success {
background: #059669;
color: #ffffff;
border-color: #059669;
}
.doc-button.danger {
background: #dc2626;
color: #ffffff;
border-color: #dc2626;
}
.doc-card {
background: var(--doc-panel);
border: 1px solid var(--doc-line);
border-radius: 1rem;
box-shadow: 0 1px 2px rgba(15, 23, 42, .06);
overflow: hidden;
}
.doc-card-header {
padding: 1rem 1.25rem;
border-bottom: 1px solid var(--doc-line);
display: flex;
align-items: center;
justify-content: space-between;
gap: 1rem;
}
.doc-card-body {
padding: 1.25rem;
}
.doc-grid {
display: grid;
gap: 1rem;
}
.doc-grid.stats {
grid-template-columns: repeat(4, minmax(0, 1fr));
}
.doc-stat {
padding: 1.25rem;
}
.doc-stat strong {
display: block;
font-size: 1.875rem;
line-height: 2.25rem;
letter-spacing: -.04em;
color: var(--doc-ink);
}
.doc-stat span {
color: var(--doc-muted);
font-size: .75rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: .08em;
}
.doc-table {
width: 100%;
border-collapse: collapse;
}
.doc-table th {
text-align: left;
font-size: .75rem;
text-transform: uppercase;
letter-spacing: .08em;
color: var(--doc-muted);
padding: .75rem;
border-bottom: 1px solid var(--doc-line);
}
.doc-table td {
padding: .875rem .75rem;
border-bottom: 1px solid var(--doc-line);
vertical-align: top;
}
.doc-table a,
.doc-link {
color: #1d4ed8;
font-weight: 700;
text-decoration: none;
}
html.dark .doc-table a,
html.dark .doc-link {
color: #93c5fd;
}
.doc-badge {
display: inline-flex;
align-items: center;
border-radius: 999px;
padding: .25rem .625rem;
font-size: .75rem;
font-weight: 800;
background: #dbeafe;
color: #1e40af;
border: 1px solid #bfdbfe;
}
.doc-badge.published {
background: #ecfdf5;
color: #065f46;
border-color: #a7f3d0;
}
.doc-badge.draft {
background: #f4f4f5;
color: #52525b;
border-color: #d4d4d8;
}
.doc-badge.archived {
background: #fef2f2;
color: #991b1b;
border-color: #fecaca;
}
html.dark .doc-badge {
background: rgba(37, 99, 235, .18);
color: #bfdbfe;
border-color: rgba(59, 130, 246, .35);
}
html.dark .doc-badge.published {
background: rgba(5, 150, 105, .18);
color: #a7f3d0;
border-color: rgba(16, 185, 129, .35);
}
html.dark .doc-badge.draft {
background: rgba(113, 113, 122, .18);
color: #d4d4d8;
border-color: rgba(161, 161, 170, .30);
}
html.dark .doc-badge.archived {
background: rgba(220, 38, 38, .16);
color: #fecaca;
border-color: rgba(248, 113, 113, .32);
}
.doc-form-grid {
display: grid;
grid-template-columns: repeat(2, minmax(0, 1fr));
gap: 1rem;
}
.doc-field.full {
grid-column: 1 / -1;
}
.doc-label {
display: block;
font-weight: 700;
margin-bottom: .5rem;
font-size: .875rem;
color: var(--doc-ink);
}
.doc-input,
.doc-select,
.doc-textarea {
width: 100%;
box-sizing: border-box;
border: 1px solid #d4d4d8;
border-radius: .75rem;
padding: .75rem .875rem;
background: #ffffff;
color: #18181b;
font: inherit;
box-shadow: 0 1px 2px rgba(15, 23, 42, .04);
}
.doc-input:focus,
.doc-select:focus,
.doc-textarea:focus {
outline: 2px solid rgba(37, 99, 235, .24);
border-color: #2563eb;
}
html.dark .doc-input,
html.dark .doc-select,
html.dark .doc-textarea {
background: #09090b;
color: #f4f4f5;
border-color: #3f3f46;
}
.doc-textarea {
min-height: 360px;
line-height: 1.6;
resize: vertical;
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;
}
.doc-editor {
border: 1px solid #d4d4d8;
border-radius: 1rem;
overflow: hidden;
background: #ffffff;
}
html.dark .doc-editor {
background: #09090b;
border-color: #3f3f46;
}
.doc-editor .doc-textarea {
border: 0;
border-radius: 0;
min-height: 420px;
}
.doc-editor-toolbar {
display: flex;
flex-wrap: wrap;
gap: .375rem;
padding: .625rem;
background: #f4f4f5;
border-bottom: 1px solid var(--doc-line);
}
html.dark .doc-editor-toolbar {
background: #18181b;
}
.doc-editor-toolbar button {
border: 1px solid #d4d4d8;
background: #ffffff;
color: #18181b;
border-radius: .625rem;
padding: .45rem .625rem;
font-weight: 800;
cursor: pointer;
}
html.dark .doc-editor-toolbar button {
border-color: #3f3f46;
background: #09090b;
color: #f4f4f5;
}
.doc-editor-toolbar button:hover,
.doc-editor-toolbar button:focus {
border-color: #2563eb;
outline: 2px solid rgba(37, 99, 235, .20);
}
.editor-help {
padding: 0 .875rem .75rem;
margin: -.25rem 0 0;
font-size: .8125rem;
}
.doc-error {
color: #dc2626;
font-size: .8125rem;
margin-top: .375rem;
}
.doc-alert {
border-radius: 1rem;
padding: .875rem 1rem;
background: #ecfdf5;
color: #065f46;
border: 1px solid #a7f3d0;
font-size: .875rem;
font-weight: 700;
}
html.dark .doc-alert {
background: #022c22;
color: #a7f3d0;
border-color: #065f46;
}
.doc-warning {
border-radius: 1rem;
padding: .875rem 1rem;
background: #fffbeb;
color: #92400e;
border: 1px solid #fcd34d;
font-size: .875rem;
}
html.dark .doc-warning {
background: #451a03;
color: #fef3c7;
border-color: #92400e;
}
.doc-filter {
display: grid;
grid-template-columns: 1fr 180px 220px auto;
gap: .75rem;
margin-bottom: 1.125rem;
}
.doc-content {
line-height: 1.75;
font-size: 1rem;
}
.doc-content h1,
.doc-content h2,
.doc-content h3 {
line-height: 1.2;
letter-spacing: -.025em;
margin: 1.4em 0 .55em;
}
.doc-content h1 { font-size: 2rem; }
.doc-content h2 { font-size: 1.55rem; border-bottom: 1px solid var(--doc-line); padding-bottom: .35rem; }
.doc-content h3 { font-size: 1.25rem; }
.doc-content p, .doc-content ul, .doc-content ol, .doc-content blockquote, .doc-content pre { margin: 0 0 1rem; }
.doc-content code { background: #f1f5f9; border-radius: 7px; padding: .14rem .32rem; font-size: .92em; }
.doc-content pre { overflow-x: auto; background: #0f172a; color: #e2e8f0; border-radius: 16px; padding: 16px; }
.doc-content p,
.doc-content ul,
.doc-content ol,
.doc-content blockquote,
.doc-content pre { margin: 0 0 1rem; }
.doc-content code { background: #f1f5f9; border-radius: .4375rem; padding: .14rem .32rem; font-size: .92em; }
html.dark .doc-content code { background: #1e293b; color: #e2e8f0; }
.doc-content pre { overflow-x: auto; background: #0f172a; color: #e2e8f0; border-radius: 1rem; padding: 1rem; }
.doc-content pre code { background: transparent; color: inherit; padding: 0; }
.doc-content blockquote { border-left: 4px solid var(--doc-brand); padding-left: 16px; color: var(--doc-muted); }
.doc-content blockquote { border-left: 4px solid #2563eb; padding-left: 1rem; color: var(--doc-muted); }
.doc-content table { width: 100%; border-collapse: collapse; margin: 1rem 0; }
.doc-content th, .doc-content td { border: 1px solid var(--doc-line); padding: 10px 12px; text-align: left; }
.doc-content th,
.doc-content td { border: 1px solid var(--doc-line); padding: .625rem .75rem; text-align: left; }
.doc-muted { color: var(--doc-muted); }
.doc-link { color: var(--doc-brand-dark); font-weight: 800; text-decoration: none; }
.doc-attachment-list { display: grid; gap: 10px; }
.doc-attachment-item { display: flex; justify-content: space-between; align-items: center; gap: 14px; border: 1px solid var(--doc-line); border-radius: 14px; padding: 12px 14px; background: #fff; }
.doc-attachment-list {
display: grid;
gap: .625rem;
}
.doc-attachment-item {
display: flex;
justify-content: space-between;
align-items: center;
gap: .875rem;
border: 1px solid var(--doc-line);
border-radius: .875rem;
padding: .75rem .875rem;
background: var(--doc-panel);
}
@media (min-width: 1024px) {
.doc-hero-row {
flex-direction: row;
align-items: center;
justify-content: space-between;
}
}
@media (max-width: 860px) {
.doc-hero { grid-template-columns: 1fr; }
.doc-grid.stats { grid-template-columns: repeat(2, minmax(0, 1fr)); }
.doc-filter, .doc-form-grid { grid-template-columns: 1fr; }
.doc-filter,
.doc-form-grid { grid-template-columns: 1fr; }
.doc-table { display: block; overflow-x: auto; }
}
@media (max-width: 560px) {
.doc-shell { padding: 16px 12px 36px; }
.doc-hero { padding: 22px; border-radius: 22px; }
.doc-grid.stats { grid-template-columns: 1fr; }
.doc-hero { padding: 1.375rem; border-radius: 1.375rem; }
}
</style>
</head>
Modules/Documentation/Resources/views/partials/hero.blade.php
+14 -10
View File
@@ -1,13 +1,17 @@
<section class="doc-hero">
<div>
<p class="doc-eyebrow">{{ $eyebrow ?? 'Documentation Suite' }}</p>
<h1>{{ $title ?? 'Documentation' }}</h1>
<p>{{ $subtitle ?? 'Manage controlled documents, policies, guides, files, and operational knowledge in one professional workspace.' }}</p>
<div class="doc-actions">
<a class="doc-button primary" href="{{ route('documentation.documents.create') }}">Create document</a>
<a class="doc-button secondary" href="{{ route('documentation.categories.index') }}">Manage categories</a>
<a class="doc-button secondary" href="{{ route('documentation.documents.index') }}">Document register</a>
<section class="doc-hero-wrap">
<div class="doc-hero">
<div class="doc-hero-row">
<div>
<p class="doc-eyebrow">{{ $eyebrow ?? 'Documentation workflow' }}</p>
<h1>{{ $title ?? 'Documentation' }}</h1>
<p>{{ $subtitle ?? 'Manage controlled documents, policies, guides, files, and operational knowledge in one professional workspace.' }}</p>
</div>
<div class="doc-actions">
<a class="doc-button primary" href="{{ route('documentation.documents.create') }}" wire:navigate>Create document</a>
<a class="doc-button secondary" href="{{ route('documentation.categories.index') }}" wire:navigate>Manage categories</a>
<a class="doc-button secondary" href="{{ route('documentation.documents.index') }}" wire:navigate>Document register</a>
</div>
</div>
</div>
<div aria-hidden="true" style="width:140px;height:140px;border-radius:32px;background:rgba(255,255,255,.16);display:grid;place-items:center;border:1px solid rgba(255,255,255,.26);font-size:58px;font-weight:900;">D</div>
</section>
Modules/Documentation/Routes/.gitkeep
View File
Modules/Documentation/Routes/api.php
-11
View File
@@ -1,11 +0,0 @@
<?php
use Illuminate\Support\Facades\Route;
Route::prefix('documentation')->name('api.documentation.')->group(function (): void {
Route::get('/status', static fn (): array => [
'module' => 'documentation',
'status' => 'ok',
'version' => '1.1.0',
])->name('status');
});
Modules/Documentation/Routes/web.php
-23
View File
@@ -1,23 +0,0 @@
<?php
use Illuminate\Support\Facades\Route;
use Modules\Documentation\Http\Controllers\DocumentationCategoryController;
use Modules\Documentation\Http\Controllers\DocumentationController;
Route::prefix(config('documentation.route_prefix', 'documentation'))
->name('documentation.')
->middleware(config('documentation.middleware', ['web', 'auth']))
->group(function (): void {
Route::get('/', [DocumentationController::class, 'index'])->name('documents.index');
Route::get('/documents/create', [DocumentationController::class, 'create'])->name('documents.create');
Route::post('/documents', [DocumentationController::class, 'store'])->name('documents.store');
Route::get('/documents/{document}', [DocumentationController::class, 'show'])->name('documents.show');
Route::get('/documents/{document}/edit', [DocumentationController::class, 'edit'])->name('documents.edit');
Route::put('/documents/{document}', [DocumentationController::class, 'update'])->name('documents.update');
Route::delete('/documents/{document}', [DocumentationController::class, 'destroy'])->name('documents.destroy');
Route::get('/documents/{document}/download', [DocumentationController::class, 'download'])->name('documents.download');
Route::get('/documents/{document}/attachments/{attachment}/download', [DocumentationController::class, 'downloadAttachment'])->name('documents.attachments.download');
Route::delete('/documents/{document}/attachments/{attachment}', [DocumentationController::class, 'destroyAttachment'])->name('documents.attachments.destroy');
Route::resource('categories', DocumentationCategoryController::class)->except(['show']);
});
Modules/Documentation/Support/.gitkeep
View File
Modules/Documentation/Support/ModuleInfo.php
-26
View File
@@ -1,26 +0,0 @@
<?php
namespace Modules\Documentation\Support;
class ModuleInfo
{
protected static string $moduleName = 'Documentation';
/**
* defines the Module Name
* @return string
*/
public static function name(): string
{
return static::$moduleName;
}
/**
* define the lowercase version
* @return string
*/
public static function nameLower(): string
{
return strtolower(static::$moduleName);
}
}
Modules/Documentation/Tests/Browser/.gitkeep
View File
Modules/Documentation/Tests/Feature/.gitkeep
View File
Modules/Documentation/Tests/Unit/.gitkeep
View File
Modules/Documentation/Traits/.gitkeep
View File
Modules/Documentation/View/.gitkeep
View File
Modules/Documentation/changelog.yaml
+16 -2
View File
@@ -1,5 +1,11 @@
version: 1.3.0
date: 2026-06-13
- version: 1.5.0
date: 2026-06-15
changes:
- Updated the Documentation module visual theme to match the WMS/Helpdesk slate-blue shell, zinc cards, dark-mode surfaces, blue primary actions, emerald success states, red danger states, and amber warnings.
- Reworked the Documentation hero to use the same professional gradient/header pattern as the Helpdesk workflow screens.
version: 1.4.0
date: 2026-06-15
changes:
- Added professional documentation dashboard and document CRUD.
- Added document categories with status, ordering, colour, and icon support.
@@ -9,4 +15,12 @@ changes:
- Added Markdown import coverage and styling for headings, code blocks, tables, and blockquotes.
- Added multiple supporting attachments per document with upload, download, removal, storage cleanup, and tests.
- Added a free built-in Markdown editor toolbar with controls for headings, bold, italic, quotes, lists, links, inline code, fenced code blocks, and tables.
- Added WMS Support sidebar integration for Documentation, New Document, and Categories links using the existing sidebar colour scheme and active-state conventions.
- Added a root documentation.index route while preserving documentation.documents.index for CRUD navigation.
- Fixed module composer metadata and synced module.json version.
- version: 1.4.1
date: 2026-06-15
changes:
- Fixed sidebar integration so Documentation is rendered directly under the existing Support menu when Documentation routes exist.
- Added direct replacement Blade block for the current WMS app shell.
Modules/Documentation/module.json
+2 -2
View File
@@ -1,8 +1,8 @@
{
"name": "Documentation",
"alias": "documentation",
"version": "1.3.0",
"description": "Professional document management and knowledge-base module with categories, CRUD, publishing, Markdown editing/import support, code blocks, and attachments.",
"version": "1.5.0",
"description": "Professional document management and knowledge-base module with categories, CRUD, publishing, Markdown editing/import support, code blocks, attachments, and WMS Support navigation integration.",
"keywords": [
"documentation",
"documents",
Modules/Documentation/package.json
-17
View File
@@ -1,17 +0,0 @@
{
"private": true,
"scripts": {
"dev": "npm run development",
"development": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
"watch": "cross-env NODE_ENV=development node_modules/webpack/bin/webpack.js --watch --progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js",
"watch-poll": "npm run watch -- --watch-poll",
"hot": "cross-env NODE_ENV=development node_modules/webpack-dev-server/bin/webpack-dev-server.js --inline --hot --config=node_modules/laravel-mix/setup/webpack.config.js",
"prod": "npm run production",
"production": "cross-env NODE_ENV=production node_modules/webpack/bin/webpack.js --no-progress --hide-modules --config=node_modules/laravel-mix/setup/webpack.config.js"
},
"devDependencies": {
"cross-env": "^7.0",
"laravel-mix": "^5.0.1",
"laravel-mix-merge-manifest": "^0.1.2"
}
}
Modules/Documentation/webpack.mix.js
-11
View File
@@ -1,11 +0,0 @@
const dotenvExpand = require('dotenv-expand');
dotenvExpand(require('dotenv').config({ path: '../../.env'/*, debug: true*/}));
const mix = require('laravel-mix');
mix.js(__dirname + '/Resources/assets/js/app.js', 'js/documentation.js')
.sass( __dirname + '/Resources/assets/sass/app.scss', 'css/documentation.css');
if (mix.inProduction()) {
mix.version();
}