Skip to content

Commit 8e93aa3

Browse files
committed
feat(docs-site): polish UI with accessible components and enhanced styling
Add comprehensive UI/UX improvements to the documentation site: - Custom CSS theme with 700+ lines of polished styling, dark mode support, and responsive design tokens - New EditLink component with "Copy page as Markdown" feature - generate-page-markdown script for generating copy-ready markdown - Enhanced Head component with Inter font loading and smooth scroll - Accessible skip links and keyboard navigation support - Content improvements across index, getting-started, and architecture pages with hero sections and enhanced CardGrid layouts - Light/dark logo configuration in Starlight config
1 parent 336749e commit 8e93aa3

60 files changed

Lines changed: 15029 additions & 33 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs-site/astro.config.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ export default defineConfig({
1414
description:
1515
'Bridge-first documentation for the ReCursor mobile companion UI and bridge architecture.',
1616
logo: {
17-
src: './src/assets/recursor-logo-light.svg',
17+
light: './src/assets/recursor-logo-light.svg',
18+
dark: './src/assets/recursor-logo-dark.svg',
1819
replacesTitle: false,
1920
},
2021
social: [
@@ -30,6 +31,7 @@ export default defineConfig({
3031
customCss: ['./src/styles/custom.css'],
3132
components: {
3233
Head: './src/components/Head.astro',
34+
EditLink: './src/components/EditLink.astro',
3335
},
3436
sidebar: [
3537
{ label: 'Home', link: '/' },

docs-site/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"description": "ReCursor documentation site powered by Astro Starlight",
77
"packageManager": "npm@11.11.0",
88
"scripts": {
9-
"generate": "node ./scripts/generate-docs.mjs && node ./scripts/generate-llms.mjs",
9+
"generate": "node ./scripts/generate-docs.mjs && node ./scripts/generate-page-markdown.mjs && node ./scripts/generate-llms.mjs",
1010
"dev": "npm run generate && astro dev",
1111
"build": "npm run generate && astro build",
1212
"check": "npm run generate && astro check && astro build",
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Architecture
2+
3+
The architecture section describes the bridge-first system design and the constraints that shape ReCursor's mobile experience.
4+
5+
<div class="hero-note" style="margin-top: 1.5rem; margin-bottom: 2rem;">
6+
**Bridge-first by design:** ReCursor intentionally avoids cloud services. All communication between the mobile app and your development environment flows through a local bridge server you control.
7+
</div>
8+
9+
## Core concepts
10+
11+
- [System overview](/architecture/system-overview/): The core component model: mobile app, bridge server, and Claude Code integration points.
12+
- [Data flow](/architecture/data-flow/): Message-level sequence diagrams showing how commands travel from mobile to desktop.
13+
- [Bridge protocol](/architecture/bridge-protocol/): The HTTP/WebSocket protocol specification for bridge communication.
14+
- [Data models](/architecture/data-models/): Core data structures: requests, responses, sessions, and repositories.
15+
- [Project structure](/architecture/project-structure/): Repository organization: Flutter app, bridge server, and documentation.
16+
17+
## Design principles
18+
19+
| Principle | Implementation |
20+
|-----------|---------------|
21+
| **Local-first** | Bridge runs on localhost, no cloud services required |
22+
| **Transparent** | All data stays in your network boundary |
23+
| **Reversible** | No persistent state changes without explicit approval |
24+
| **Observable** | Full logging and monitoring of all bridge traffic |
25+
26+
## Navigation guide
27+
28+
- Start with [System overview](/architecture/system-overview/) for the core component model
29+
- Use [Data flow](/architecture/data-flow/) when you need message-level sequence details
30+
- Read [Bridge protocol](/architecture/bridge-protocol/) and [Project structure](/architecture/project-structure/) for implementation-facing reference material

0 commit comments

Comments
 (0)