⚠️ REPOSITORY ARCHIVED - Moved to Monorepo

This repository has been archived and is now maintained in the larcjs/larc monorepo.

New Location: larcjs/larc/docs/site

🌐 The live site is still active: https://larcjs.github.io/larc/docs/site/

---

🔄 Migration Information

• Date: December 6, 2025
• Reason: Consolidated documentation into monorepo for easier maintenance alongside code
• Status: This repo is read-only, all development happens in the monorepo
• Issues/PRs: Please open them at larcjs/larc

---

LARC Site

Official documentation website and showcase for the LARC/PAN ecosystem

The central hub for LARC documentation, guides, API references, and interactive demos.

🌐 Live Site: https://larcjs.github.io/larc/docs/site/

---

📚 What's Inside

Documentation

• Getting Started Guide — Quick introduction to LARC/PAN
• API Reference — Complete API documentation
• Topic Conventions — Message pattern guidelines
• Architecture Guide — System design and patterns
• Security Best Practices — Secure application development
• Migration Guides — Upgrade paths and breaking changes

Interactive Pages

• Component Gallery — Visual showcase of all UI components
• Demo Applications — Full-featured app examples
• Examples Index — Categorized example browser
• Component Registry — Searchable component catalog
• Theme Showcase — Theming capabilities demonstration

Resources

• Roadmap — Future plans and version goals
• Changelog — Version history and updates
• Contributing Guide — How to contribute
• FAQ — Frequently asked questions

---

🚀 Local Development

Note: Development now happens in the monorepo. See larcjs/larc for current setup instructions.

Prerequisites

• Node.js 16+ (for build scripts)
• Python 3 (for local server, or use any alternative)

Setup (Legacy - use monorepo instead)

1. Clone the repository:

   git clone https://github.com/larcjs/larc.git
   cd larc/docs/site

2. Start local server:

   python3 -m http.server 8000
   # or
   npx serve .

3. Open in browser:

   http://localhost:8000
   

---

📝 Documentation Files

All documentation is in plain HTML/Markdown for zero-build philosophy:

• index.html — Homepage
• docs/ — Documentation pages
  • getting-started.html
  • api-reference.html
  • architecture.html
  • security.html
• examples/ — Code examples
• components/ — Component demos
• assets/ — Styles and images

---

🌐 Deployment

The site is automatically deployed to GitHub Pages from the monorepo:

• Source: larcjs/larc/docs/site
• URL: https://larcjs.github.io/larc/docs/site/
• CI: GitHub Actions in main monorepo

---

🤝 Contributing

Important: All contributions should now be made to the monorepo.

1. Fork larcjs/larc
2. Create a feature branch
3. Make changes in docs/site/
4. Submit PR to the monorepo

See CONTRIBUTING.md in the monorepo.

---

📦 Project Structure

site/ (now at larcjs/larc/docs/site/)
├── index.html          # Homepage
├── gallery.html        # Component gallery
├── examples.html       # Examples index
├── apps.html           # Demo applications
├── docs/              # Documentation
│   ├── getting-started.html
│   ├── api-reference.html
│   ├── architecture.html
│   └── ...
├── examples/          # Code examples
│   ├── basic/
│   ├── advanced/
│   └── ...
├── components/        # Component demos
├── assets/           # Styles, images
└── generate-docs.mjs # Doc generation script

---

🔗 Links

• LARC Monorepo ← Development happens here
• Live Documentation
• LARC Core
• LARC Components
• Report Issues ← Report issues here

---

📜 License

MIT

---

⚡ Quick Links for Developers

• Edit docs: larcjs/larc/docs/site
• File issues: larcjs/larc/issues
• View live site: larcjs.github.io/larc/docs/site