Laravel Chronicle Docs

This directory contains the Docusaurus site for the laravel-chronicle/core package documentation.

What is here

• package documentation pages under docs/
• the homepage and custom theme styling under src/
• static site assets such as the Chronicle logo and favicon under static/

Install dependencies

npm install

Local development

Run the docs site locally:

npm run start

Build and serve the production output locally:

npm run build
npm run serve

Useful scripts

• npm run start starts the local development server
• npm run build creates the production build in build/
• npm run serve serves the built site locally
• npm run clear clears the Docusaurus cache
• npm run typecheck runs TypeScript checks for the docs app

Docs structure

The sidebar is defined in sidebars.ts.

The current information architecture is organized as:

• top-level onboarding pages
• Foundations
• Guides
• Reference
• Operations

Updating the docs

When updating documentation for laravel-chronicle/core:

1. verify the behavior against the code in ../core
2. update the relevant page under docs/
3. run npm run build to catch broken routes, links, and MDX issues

Deployment

This is a standard Docusaurus site and can be deployed as static files from the generated build/ directory.