Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,23 @@
}
}
},
"overrides": [
{
"includes": ["modules/*/src/*/types.ts"],
"linter": {
"rules": {
"suspicious": {
"noExplicitAny": "off"
},
"complexity": {
"noBannedTypes": "off",
"noEmptyTypeParameters": "off"
}
}
}
}
],
"files": {
"includes": [
"modules/**",
"packages/**",
"template/**",
"tests/**",
"!**/wwwroot",
"!**/types.ts"
]
"includes": ["modules/**", "packages/**", "template/**", "tests/**", "docs/**", "!**/wwwroot"]
}
}
43 changes: 43 additions & 0 deletions docs/plans/2026-03-26-documentation-site-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Documentation Site Design

**Date:** 2026-03-26
**Status:** Approved
**Framework:** VitePress
**URL:** docs.simplemodule.dev

## Overview

Public-facing documentation site for SimpleModule framework users. Markdown-based, powered by VitePress, hosted at docs.simplemodule.dev.

## Audience

Developers who install SimpleModule via NuGet/npm and build modular monolith applications with it.

## Technology Choice

VitePress — lightest, fastest, best out-of-box developer docs experience, markdown-first.

## Site Structure

```
docs/site/
├── .vitepress/config.ts — Nav, sidebar, theme configuration
├── public/favicon.svg — Site favicon
├── index.md — Landing/hero page
├── getting-started/ — Introduction, quick start, project structure
├── guide/ — Core concepts (modules, endpoints, contracts, DB, events, permissions, menus, settings, inertia)
├── frontend/ — React + Inertia architecture, pages, components, styling, Vite
├── cli/ — sm command reference
├── testing/ — Test stack, unit/integration/e2e patterns
├── advanced/ — Source generator, type generation, interceptors, deployment
└── reference/ — Configuration options, API reference
```

## Key Decisions

- No versioning (pre-1.0, single version)
- Built-in local search (miniSearch)
- Dark/light mode toggle
- GitHub link in header
- Edit on GitHub links per page
- Separate npm workspace in docs/site/
Loading