@jmruthers/pace-core 0.5.76 → 0.5.78

package/docs/documentation-index.md

@@ -1,182 +1,121 @@
-# PACE Core Documentation Index
-
-> **📚 Complete Documentation Reference** | [Quick Start](./getting-started/quick-start.md) | [API Reference](./api-reference/components.md) | [Troubleshooting](./troubleshooting/README.md) | [← Back to Docs](./README.md)
-
-Complete index of all PACE Core documentation organized by topic and use case.
-
----
-
-**Last Updated:** 2025-01-XX | **Version:** v0.5.65+
-
-## 🚀 Getting Started
-
-### First Time Users
-- **[Installation](./getting-started/installation-guide.md)** - Package installation and basic setup (START HERE)
-- **[Quick Start](./getting-started/quick-start.md)** - Build your first app in 10 minutes
-- **[Examples](./getting-started/examples/README.md)** - Complete working examples
-- **[FAQ](./faq.md)** - Common questions and quick answers
-
-### Configuration
-- **[Vite Configuration](./consuming-app-vite-config.md)** - **CRITICAL** Tailwind v4 setup
-
-## 🏗️ Core Features
-
-### Authentication & Security
-- **[Authentication Overview](./core-concepts/authentication.md)** - User management and sessions
-- **[RBAC System](./rbac/README.md)** - Role-based access control
-- **[Security Best Practices](./best-practices/security.md)** - Security guidelines
-- **[Permission Enforcement](./implementation-guides/permission-enforcement.md)** - Implementing permissions
-
-### Data Management
-- **[Data Tables](./implementation-guides/data-tables.md)** - Interactive data management
-- **[Forms](./implementation-guides/forms.md)** - Form handling and validation
-- **[File Upload & Storage](./implementation-guides/file-upload-storage.md)** - **NEW** Complete file management system
-- **[Events](./core-concepts/events.md)** - Event management
-- **[Organisations](./core-concepts/organisations.md)** - Multi-tenant support
-- **[Public Pages](./implementation-guides/public-pages.md)** - Public pages without authentication
-- **[Public Pages Advanced](./implementation-guides/public-pages-advanced.md)** - **NEW** Advanced public page patterns
-
-### UI & Layout
-- **[Components API](./api-reference/components.md)** - Complete component reference
-- **[App Layout](./implementation-guides/app-layout.md)** - Application structure
-- **[Navigation](./implementation-guides/navigation.md)** - Navigation patterns
-
-## 🎨 Styling & Theming
-
-### Design System
-- **[Styling Overview](./styles/README.md)** - Complete design system
-
-## 🚨 Important Notices
-
-### Breaking Changes
-- **[Breaking Changes](./breaking-changes.md)** - All breaking changes (CRITICAL - read before upgrading)
-
-## 🔧 API Reference
-
-### Components
-- **[UI Components](./api-reference/components.md)** - Button, Card, Input, etc.
-- **[Data Components](./api-reference/components.md#data-table)** - DataTable, Form, etc.
-- **[Layout Components](./api-reference/components.md#layout-components)** - PaceAppLayout, Header, etc.
-
-### Hooks & Utilities
-- **[React Hooks](./api-reference/hooks.md)** - useUnifiedAuth, useCan, etc.
-- **[RBAC Hooks](./rbac/README.md#hooks)** - Permission checking hooks
-- **[Utilities](./api-reference/utilities.md)** - Helper functions
-
-## 🎯 Best Practices
-
-### Development
-- **[Best Practices Overview](./best-practices/README.md)** - Comprehensive guide
-- **[Performance](./best-practices/performance.md)** - Optimization strategies
-- **[Testing](./best-practices/testing.md)** - Testing patterns
-- **[Code Quality](./best-practices/README.md#code-quality)** - TypeScript, code structure
-
-### Production
-- **[Deployment](./best-practices/deployment.md)** - Production deployment
-- **[Security](./best-practices/security.md)** - Security guidelines
-- **[Monitoring](./best-practices/README.md#monitoring)** - Performance monitoring
-
-## 🐛 Troubleshooting
-
-### Common Issues
-- **[Troubleshooting Overview](./troubleshooting/README.md)** - Complete guide
-- **[Common Issues](./troubleshooting/common-issues.md)** - Frequent problems
-- **[Styling Issues](./troubleshooting/styling-issues.md)** - Component styling
-
-### Debugging
-- **[Debugging Guide](./troubleshooting/debugging.md)** - Debug techniques
-
-## 🔄 Migration & Updates
-
-### Version Updates
-- **[Unified Migration Guide](./migration/MIGRATION_GUIDE.md)** - **NEW** Complete migration reference
-- **[Migration Overview](./migration/README.md)** - Individual migration guides
-- **[v0.4.17 Source Path Fix](./migration/v0.4.17-source-path-fix.md)** - **CRITICAL** Fix
-- **[v0.4.16 CSS-First Migration](./migration/v0.4.16-css-first-approach.md)** - Simplified config
-- **[v0.4.15 Tailwind Scanning](./migration/v0.4.15-tailwind-scanning.md)** - Legacy approach
-
-### Breaking Changes
-- **[RBAC Migration](./migration/rbac-migration.md)** - RBAC system updates
-
-## 📖 Core Concepts
-
-### Understanding PACE Core
-- **[Architecture](./architecture/README.md)** - System architecture
-
-### Key Concepts
-- **[Authentication](./core-concepts/authentication.md)** - User management and sessions
-- **[Permissions](./core-concepts/permissions.md)** - Permission system
-- **[Events](./core-concepts/events.md)** - Event management
-- **[Organisations](./core-concepts/organisations.md)** - Multi-tenancy
-
-## 🛠️ Implementation Guides
-
-### Application Structure
-- **[App Layout](./implementation-guides/app-layout.md)** - Layout patterns
-- **[Navigation](./implementation-guides/navigation.md)** - Navigation systems
-
-### Data & Forms
-- **[Data Tables](./implementation-guides/data-tables.md)** - Data management
-- **[Forms](./implementation-guides/forms.md)** - Form implementation
-- **[File Upload & Storage](./implementation-guides/file-upload-storage.md)** - File handling
-
-### Advanced Features
-- **[Permission Enforcement](./implementation-guides/permission-enforcement.md)** - Security implementation
-- **[Inactivity Tracking](./implementation-guides/inactivity-tracking.md)** - **NEW** User session management
-- **[Organisation Security](./implementation-guides/organisation-security.md)** - **NEW** Advanced security patterns
-- **[Public Pages](./implementation-guides/public-pages.md)** - Public pages without authentication
-- **[Public Pages Advanced](./implementation-guides/public-pages-advanced.md)** - **NEW** Advanced public page patterns
-
-## 🎨 Styling Guides
-
-### Design System
-- **[Styling Overview](./styles/README.md)** - Complete design system
-
-## 🎯 Common Patterns
-
-- **[Common Patterns](./common-patterns.md)** - Reusable code patterns and best practices
-
-## 🔍 Search by Use Case
-
-### I want to...
-- **Build a new app** → [Quick Start](./getting-started/quick-start.md)
-- **See code patterns** → [Common Patterns](./common-patterns.md)
-- **Add authentication** → [Authentication Guide](./core-concepts/authentication.md)
-- **Implement permissions** → [RBAC System](./rbac/README.md)
-- **Create data tables** → [Data Tables Guide](./implementation-guides/data-tables.md)
-- **Style my app** → [Styling Overview](./styles/README.md)
-- **Fix styling issues** → [Troubleshooting - Styling](./troubleshooting/styling-issues.md)
-- **Find quick answers** → [FAQ](./faq.md)
-- **Check breaking changes** → [Breaking Changes](./breaking-changes.md)
-- **Optimize performance** → [Performance Best Practices](./best-practices/performance.md)
-- **Deploy to production** → [Deployment Guide](./best-practices/deployment.md)
-- **Migrate from v0.x** → [Migration Guide](./migration/README.md)
-- **Debug an issue** → [Troubleshooting Overview](./troubleshooting/README.md)
-
-### I'm looking for...
-- **Component documentation** → [Components API](./api-reference/components.md)
-- **Hook reference** → [Hooks API](./api-reference/hooks.md)
-- **Code examples** → [Examples](./getting-started/examples/README.md)
-- **Best practices** → [Best Practices](./best-practices/README.md)
-- **Security guidelines** → [Security Best Practices](./best-practices/security.md)
-- **Performance tips** → [Performance Best Practices](./best-practices/performance.md)
-- **Deployment guide** → [Deployment Best Practices](./best-practices/deployment.md)
-- **Testing strategies** → [Testing Best Practices](./best-practices/testing.md)
-
-## 📚 Additional Resources
-
-### External Links
-- **[Supabase Documentation](https://supabase.com/docs)** - Backend services
-- **[Tailwind CSS Documentation](https://tailwindcss.com/docs)** - CSS framework
-- **[React Documentation](https://react.dev)** - React framework
-- **[TypeScript Documentation](https://www.typescriptlang.org/docs)** - Type system
-
-### Community
-- **[GitHub Repository](https://github.com/jmruthers/pace-core)** - Source code
-- **[Issue Tracker](https://github.com/jmruthers/pace-core/issues)** - Bug reports
-- **[Discussions](https://github.com/jmruthers/pace-core/discussions)** - Community help
-- **[Migration Guides](./migration/MIGRATION_GUIDE.md)** - Version history and migration info
-
----
-
-**Need help?** Check the [Troubleshooting Guide](./troubleshooting/README.md) or [ask for help](https://github.com/jmruthers/pace-core/discussions).
+# Documentation index
+
+This index mirrors the folder layout in `packages/core/docs/` so teams can quickly locate the right reference or guide. Update this file whenever new docs are added or renamed.
+
+## Getting started
+
+- [Installation guide](./getting-started/installation-guide.md) – package, peer dependency, and Tailwind setup.
+- [Quick reference](./getting-started/quick-reference.md) – one page of common imports and commands.
+- [Vite configuration](./getting-started/consuming-app-vite-config.md) – include PACE Core sources when scanning Tailwind classes.
+- [FAQ](./getting-started/faq.md) – fast answers to onboarding questions.
+- [Getting started roadmap](./getting-started/documentation-index.md) – the task-by-task plan after installation.
+
+## Core concepts
+
+- [Authentication](./core-concepts/authentication.md) – Supabase session lifecycle, inactivity, and context.
+- [Permissions](./core-concepts/permissions.md) – RBAC primitives and evaluation flow.
+- [Organisations](./core-concepts/organisations.md) – tenant context and membership rules.
+- [Events](./core-concepts/events.md) – event access model for multi-event apps.
+- [RBAC system overview](./core-concepts/rbac-system.md) – the conceptual map before diving into the RBAC module.
+
+## API reference
+
+- [Components](./api-reference/components.md)
+- [Hooks](./api-reference/hooks.md)
+- [Providers](./api-reference/providers.md)
+- [Types](./api-reference/types.md)
+- [Utilities](./api-reference/utilities.md)
+
+## Implementation guides
+
+- [Authentication flow](./implementation-guides/authentication.md)
+- [App layout](./implementation-guides/app-layout.md)
+- [Component styling](./implementation-guides/component-styling.md)
+- [Data tables](./implementation-guides/data-tables.md)
+- [Dynamic colours](./implementation-guides/dynamic-colors.md)
+- [Event theming summary](./implementation-guides/event-theming-summary.md)
+- [File reference system](./implementation-guides/file-reference-system.md)
+- [File upload & storage](./implementation-guides/file-upload-storage.md)
+- [Forms](./implementation-guides/forms.md)
+- [Inactivity tracking](./implementation-guides/inactivity-tracking.md)
+- [Navigation](./implementation-guides/navigation.md)
+- [Organisation security](./implementation-guides/organisation-security.md)
+- [Permission enforcement](./implementation-guides/permission-enforcement.md)
+- [Public pages](./implementation-guides/public-pages.md)
+- [Public pages (advanced)](./implementation-guides/public-pages-advanced.md)
+
+## RBAC module
+
+- [Overview](./rbac/README.md)
+- [Quick start](./rbac/quick-start.md)
+- [Getting started](./rbac/getting-started.md)
+- [API reference](./rbac/api-reference.md)
+- [Examples](./rbac/examples.md)
+- [Advanced patterns](./rbac/advanced-patterns.md)
+- [Super admin guide](./rbac/super-admin-guide.md)
+- [RLS integration](./rbac/rbac-rls-integration.md)
+- [Migration guide](./rbac/migration-guide.md)
+- [Breaking changes v3](./rbac/breaking-changes-v3.md)
+- [Troubleshooting](./rbac/troubleshooting.md)
+- [Legacy RLS README](./rbac/README-rbac-rls-integration.md)
+
+## Styling & theming
+
+- [Design system](./styles/README.md)
+- [Usage guide](./styles/usage.md)
+- [`app.css` example](./styles/app.css.example)
+
+## Testing & quality
+
+- [Testing overview](./testing/README.md)
+- [Visual testing](./testing/visual-testing.md)
+
+## Troubleshooting
+
+- [Overview](./troubleshooting/README.md)
+- [Common issues](./troubleshooting/common-issues.md)
+- [Styling issues](./troubleshooting/styling-issues.md)
+- [Tailwind content scanning](./troubleshooting/tailwind-content-scanning.md)
+- [Organisation context setup](./troubleshooting/organisation-context-setup.md)
+- [Cake page permission guard issue summary](./troubleshooting/cake-page-permission-guard-issue-summary.md)
+- [Database view compatibility](./troubleshooting/database-view-compatibility.md)
+- [React hooks issue analysis](./troubleshooting/react-hooks-issue-analysis.md)
+
+## Migration & release notes
+
+- [Migration overview](./migration/README.md)
+- [Unified migration guide](./migration/MIGRATION_GUIDE.md)
+- [Organisation context timing fix](./migration/organisation-context-timing-fix.md)
+- [Service architecture changes](./migration/service-architecture.md)
+- [RBAC migration](./migration/rbac-migration.md)
+- [Tailwind scanning updates](./migration/v0.4.15-tailwind-scanning.md)
+- [CSS-first migration (v0.4.16)](./migration/v0.4.16-css-first-approach.md)
+- [Source path fix (v0.4.17)](./migration/v0.4.17-source-path-fix.md)
+
+## Architecture
+
+- [System architecture](./architecture/README.md)
+- [Services architecture](./architecture/services.md)
+- [RBAC security architecture](./architecture/rbac-security-architecture.md)
+- [Database schema requirements](./architecture/database-schema-requirements.md)
+
+## Best practices
+
+- [Overview](./best-practices/README.md)
+- [Accessibility](./best-practices/accessibility.md)
+- [Common patterns](./best-practices/common-patterns.md)
+- [Deployment](./best-practices/deployment.md)
+- [Performance](./best-practices/performance.md)
+- [Security](./best-practices/security.md)
+- [Testing](./best-practices/testing.md)
+
+## Security
+
+- [Security posture](./security/README.md)
+- [Security checklist](./security/checklist.md)
+
+## Meta & maintenance
+
+- [Documentation style guide](./STYLE_GUIDE.md)
+- [Content audit report](./CONTENT_AUDIT_REPORT.md)
+- [Documentation audit notes](./DOCUMENTATION_AUDIT.md)

package/docs/{consuming-app-vite-config.md → getting-started/consuming-app-vite-config.md}

@@ -1,3 +1,9 @@
+---
+lastUpdated: 2025-10-29T22:43:00+11:00
+version: 0.5.76
+reviewedBy: content-audit
+---
+
 # Consuming App Vite Configuration
 
 This document shows the **CRITICAL** Vite configuration for consuming apps using pace-core with Tailwind v4. Proper configuration is essential to ensure pace-core components are styled correctly.

package/docs/getting-started/documentation-index.md

@@ -0,0 +1,40 @@
+# Getting started roadmap
+
+Follow this checklist after installing `@jmruthers/pace-core`. Each step points to the deeper guide you will need next.
+
+## 1. Prepare the project
+
+- ✅ Install the package and peers → [Installation guide](./installation-guide.md)
+- ✅ Configure Tailwind scanning → [Consuming app Vite config](./consuming-app-vite-config.md)
+- ✅ Import base styles → [`@jmruthers/pace-core/styles/core.css`](../styles/README.md)
+
+## 2. Connect authentication
+
+- ✅ Create a Supabase client and wrap the app → [Authentication concept](../core-concepts/authentication.md)
+- ✅ Configure inactivity timeouts and modals → [Inactivity tracking guide](../implementation-guides/inactivity-tracking.md)
+- ✅ Decide on required organisation context → [Organisation security](../implementation-guides/organisation-security.md)
+
+## 3. Enable RBAC
+
+- ✅ Load permission data → [RBAC quick start](../rbac/quick-start.md)
+- ✅ Enforce permissions in components → [Permission enforcement](../implementation-guides/permission-enforcement.md)
+- ✅ Roll out advanced rules when needed → [RBAC advanced patterns](../rbac/advanced-patterns.md)
+
+## 4. Build the interface
+
+- ✅ Assemble layout primitives → [App layout](../implementation-guides/app-layout.md)
+- ✅ Wire navigation → [Navigation guide](../implementation-guides/navigation.md)
+- ✅ Render data-rich pages → [Data tables](../implementation-guides/data-tables.md) & [Forms](../implementation-guides/forms.md)
+
+## 5. Harden and ship
+
+- ✅ Apply the design system tokens → [Styling usage](../styles/usage.md)
+- ✅ Run the test playbook → [Testing overview](../testing/README.md)
+- ✅ Prepare for production → [Deployment best practices](../best-practices/deployment.md)
+- ✅ Review security posture → [Security checklist](../security/checklist.md)
+
+## Need help?
+
+- Troubleshooting index → [Start here](../troubleshooting/README.md)
+- Frequently asked questions → [FAQ](./faq.md)
+- Missing tutorial? Add it to the backlog noted in the [docs homepage](../README.md#known-gaps--next-steps).