> For the complete documentation index, see [llms.txt](https://faction-os.gitbook.io/faction-os-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://faction-os.gitbook.io/faction-os-docs/public-demo/docs_public-demo/project-overview.md). # Project Overview `public-demo/` is the zero-install public showcase for FactionOS. It exists so someone can open a URL and understand the product shape without installing the workspace, starting the local server, configuring CLI hooks, or connecting to a War Room. It is best treated as a small standalone browser project that happens to live in the larger FactionOS repository. ## Purpose The demo should answer one question quickly: ``` What does FactionOS feel like when AI coding sessions become a live battlefield? ``` It does that with: * a splash screen * an asset-driven 2D battlefield * synthetic heroes from the five factions * generated missions and tool uses * a mission log with filtering and search * a roster and scroll shelf * achievements * mission heatmap * faction standings * command palette * keyboard shortcuts * a compact replay concept * PWA metadata and offline reload support after first visit ## Non-Goals The standalone demo does not prove or exercise the full product runtime. It does not: * run the FactionOS server * connect to WebSockets * read local files * install CLI hooks * consume Claude Code, Cursor, or OpenCode events * call LLM APIs * persist authoritative state * federate through the War Room * import workspace packages Use the full app for those checks. ## Audience The demo is for: * first-time visitors * README links * Cloudflare Pages public links such as `https://demo.faction-os.com/` * talks and screenshots * quick design review * non-developer sharing It is not the right target for validating protocol compatibility, server routes, CLI behavior, adapters, or full-product deployment. ## Standalone Contract The public demo must remain copyable as a directory. A static host should be able to serve `public-demo/` without: * `npm install` * a bundler * Vite * Node.js at runtime * a server API * workspace package resolution * environment variables The first visit still needs network access to browser CDNs for React, Tailwind, and fonts. After a successful first visit, the service worker can cache the shell, local battlefield assets, and allowed CDN responses for offline reloads. ## Relationship To The Full App The demo mirrors product vocabulary and selected UI behavior, but it does not share runtime code. It is manually kept in sync with the full app where useful. For the repository-level sharing boundary, see [`../../docs/public-demo-code-sharing.md`](/faction-os-docs/docs/public-demo-code-sharing.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://faction-os.gitbook.io/faction-os-docs/public-demo/docs_public-demo/project-overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.