Documentation Site

The /docs directory contains the Jekyll source for the MWNF Inventory documentation site deployed to GitHub Pages.

Purpose

The site has two primary manual documentation tracks:

understanding/ explains the Inventory model, import process, validation approach, and architecture for customers, content owners, and validators.
collaborators/ orients developers and technical collaborators around the codebase, Filament back-office, importer, APIs, documentation, and validation workflow.

Generated references remain available for detailed lookup:

api/ links to Swagger UI, OpenAPI JSON, and generated TypeScript client reference.
_model/ contains generated Laravel model documentation.
_docs/ contains generated commit-history documentation.
api-client/ contains generated TypeScript client documentation.

Manual content

Directory/File	Purpose
`index.md`	Site homepage and audience routing.
`understanding/`	Customer and validation documentation.
`collaborators/`	Developer and technical collaborator orientation.
`api/`	Management API reference entry point.
`models/`	Generated model reference entry point.
`deployment/`	Operational deployment reference.
`development/`	Technical archive and generated copies of script/workflow documentation.
`guidelines/`	Detailed backend and generator guidelines.
`frontend-blade/`	Legacy `/web` frontend archive.
`frontend-vue-sample/`	Vue sample application reference.

Generated content

Directory/File	Generated by	Purpose
`_docs/`	`scripts/generate-commit-docs.py`	Commit history pages.
`api-client/`	`scripts/generate-client-docs.py`	TypeScript API client reference pages.
`_model/`	`php artisan docs:model`	Laravel model schemas and relationships.
`development/scripts.md`	Jekyll plugin `copy_readme_files.rb`	Copy of `/scripts/README.md`.
`development/workflows.md`	Jekyll plugin `copy_readme_files.rb`	Copy of `/.github/workflows/README.md`.
`development/documentation-site.md`	Jekyll plugin `copy_readme_files.rb`	Copy of this README.
`_openapi/api.json`	Laravel Scramble	OpenAPI specification.
`_openapi/swagger-ui.html`	Manual static asset	Swagger UI shell.
`_site/`	Jekyll build	Generated static site output.

Build locally

Run the Jekyll build from the repository root with the project script:

. ./scripts/jekyll-build.ps1

Or run Jekyll directly from the docs/ directory in an environment with Ruby and Bundler:

bundle exec jekyll build

On Windows, use WSL or Docker when Ruby is not available on the host.

Deployment

GitHub Pages deployment builds this site automatically through the repository documentation workflow. The workflow generates commit documentation, generates API client documentation, builds Jekyll, and uploads the static artifact.