Skip to content

Commit 7a58406

Browse files
committed
update
1 parent 30a3b4b commit 7a58406

82 files changed

Lines changed: 20546 additions & 7884 deletions

File tree

Some content is hidden

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

‎.github/workflows/deploy.yml‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ jobs:
1919
runs-on: ubuntu-latest
2020
steps:
2121
- name: Checkout your repository using git
22-
uses: actions/checkout@v4
22+
uses: actions/checkout@v7
2323
- name: Install, build, and upload your site
24-
uses: withastro/action@v3
25-
# with:
26-
# path: . # The root location of your Astro project inside the repository. (optional)
27-
# node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 20. (optional)
28-
# package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
24+
uses: withastro/action@v6
25+
with:
26+
node-version: 24
27+
build-cmd: npm run check && npm run build
2928

3029
deploy:
3130
needs: build
@@ -36,4 +35,4 @@ jobs:
3635
steps:
3736
- name: Deploy to GitHub Pages
3837
id: deployment
39-
uses: actions/deploy-pages@v4
38+
uses: actions/deploy-pages@v5

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
24

‎README.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,31 @@ This repo contains documentation source of Orbit official documentation site. Th
1313
<a href="https://github.com/zumerlab/orbit-docs/graphs/contributors">
1414
<img src="https://contrib.rocks/image?repo=zumerlab/orbit-docs" />
1515
</a>
16+
17+
## Local development
18+
19+
Use Node.js 24 LTS (`nvm use`, from `.nvmrc`); Astro requires at least Node.js 22.12.
20+
21+
```sh
22+
npm ci
23+
npm run dev
24+
```
25+
26+
Astro serves the site at `/orbit-docs/`. The homepage playground and documentation examples use the same checked-in Orbit build; no CDN is needed for Orbit itself.
27+
28+
## Updating Orbit
29+
30+
```sh
31+
# Compile and copy the sibling Orbit checkout (requires its npm dependencies).
32+
npm run sync:orbit
33+
# Or choose a different checkout:
34+
ORBIT_DIR=/path/to/orbit npm run sync:orbit
35+
npm run check:orbit
36+
npm run build
37+
```
38+
39+
`sync:orbit` compiles the source and copies the five distributables into `src/assets/` and `public/orbit/`. The latter serves downloads and iframe previews. `public/orbit/manifest.json` records the package version, source commit, source digest and SHA-256 hash of every file. Commit the assets and manifest together when updating Orbit.
40+
41+
The normal build only verifies these copies; CI and fresh clones do not need a sibling repository or network access to fetch Orbit. A changed or missing asset fails the build instead of silently mixing versions. This sync does not bump versions or publish either project.
42+
43+
The current source build and published npm package both identify as `1.4.12`, but npm predates the hybrid runtime and ES module fixes. The manifest's source commit identifies the site build precisely. Installation docs and copied playground examples offer that build directly until a separate package release is published.

‎astro.config.mjs‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
import { defineConfig } from 'astro/config';
22
import starlight from '@astrojs/starlight';
3-
import react from "@astrojs/react";
43
import svelte from '@astrojs/svelte';
54

65
// https://astro.build/config
76
export default defineConfig({
87
site: 'https://zumerlab.github.io/orbit-docs',
98
base: 'orbit-docs',
9+
// Keep HTML-aware whitespace for the existing documentation.
10+
compressHTML: true,
1011
integrations: [starlight({
1112
head: [
1213
{
@@ -53,8 +54,8 @@ export default defineConfig({
5354
themes: ['github-light'],
5455
useStarlightDarkModeSwitch: false
5556
},
56-
title: 'Orbit CSS radial UI composer',
57-
description: 'Get started building an amazing cool radial UI with Orbit CSS composer',
57+
title: 'Orbit',
58+
description: 'Compose radial interfaces with HTML, CSS, and a lightweight JavaScript runtime. Explore live examples, customize layouts, and copy the code.',
5859

5960
disable404Route: true,
6061
lastUpdated: true,
@@ -68,10 +69,10 @@ export default defineConfig({
6869
Footer: './src/components/OrbitFooter.astro',
6970
Pagination: "./src/components/CustomPagination.astro"
7071
},
71-
social: {
72-
github: 'https://github.com/zumerlab/orbit',
73-
telegram: 'https://t.me/ZumlyCommunity'
74-
},
72+
social: [
73+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/zumerlab/orbit' },
74+
{ icon: 'telegram', label: 'Telegram', href: 'https://t.me/ZumlyCommunity' }
75+
],
7576
editLink: {
7677
baseUrl: 'https://github.com/zumerlab/orbit-docs/edit/main/',
7778
},
@@ -260,9 +261,6 @@ export default defineConfig({
260261
}]
261262
}]
262263
}),
263-
react({
264-
include: ['**/react/*'],
265-
}),
266264
svelte({
267265
include: ['**/svelte/*'],
268266
})]

‎design/home-contract.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Orbit home and playground
2+
3+
## Evidence
4+
5+
Primary references: the user's current home at https://zumerlab.com/orbit-docs/
6+
(dark blue, blue/coral arcs, concentric ticks and an orbital composition), and
7+
the verified `orbit/examples/playground.html` (direct manipulation and real code).
8+
9+
UIZZE catalogue searches exposed metadata for three relevant editing screens:
10+
11+
- [Whop tutorial editor](https://uizze.com/screens/69ac7efa003848282eff): select
12+
the subject before editing it. Transfer recipe navigation, not course branding.
13+
- [Wix post design](https://uizze.com/screens/6999d52a001d656e575d): scoped settings
14+
and explanatory states. Transfer disclosure of code, not the business content.
15+
- [Apollo filters](https://uizze.com/screens/6995634a0013a4ec6281): explicit grouped
16+
parameters. Transfer control grouping, not CRM fields or density.
17+
18+
Evidence limitation: indexed descriptions were available, but direct screen
19+
requests returned 410. Their visual layouts were not verified. The user's own
20+
home and working playground govern the actual visual treatment.
21+
22+
User revision: keep the established layout and colors, use the original docs logo,
23+
and remove decorative numbering, spaced uppercase labels and monospace UI text.
24+
The [sci-fi example](http://127.0.0.1:4326/orbit-docs/examples/scifi/) supplies the
25+
separate depth layers. The user's [SnapDOM reference](https://snapdom.dev/showcase/#orbit)
26+
supplies the automatic tilt: a slow rotation around both X and Y axes. Preserve
27+
the satellite control and add pause/resume; no pointer movement is required.
28+
29+
## Contract
30+
31+
| Field | Decision |
32+
| --- | --- |
33+
| Job | Understand radial composition, change it and leave with working code. |
34+
| User/action | Developer adjusts a live parameter, then copies or downloads the composition. |
35+
| Hierarchy | Purpose + live branded composition; playground; editable recipes; installation/docs. |
36+
| Navigation | Visible Playground, Examples, Docs, GitHub; existing docs URLs preserved. |
37+
| Visual language | Existing #060f16, #3da9fc, #ef4565 and original docs SVG logo; real Orbit geometry; Arial for UI and compositions, monospace only for code; sentence case labels without numbering; thin rules and space around the compositions. |
38+
| States | Zero, 80 satellites, reorder, recipe selection, mobile preview/code, copy/export loading/success/failure, reset. |
39+
| Responsive | Desktop preview beside settings/code; mobile preview/code views, native labelled controls, reachable navigation. |
40+
| Motion | Layered hero tilts automatically in 3D, with pause/resume and live satellite count. Reduced-motion prevents autoplay. Suspend animation offscreen and in hidden tabs. |
41+
| Forbidden | Invented logos, numbered section labels, uppercase micro-labels, generic slogans, invented adoption metrics, unrelated illustrations, forced signup, decorative dashboard cards. |
42+
| Acceptance | Useful controls above fold on desktop; no 360px overflow; keyboard/focus support; source matches preview; standalone export runs offline; docs/search/mobile nav work. |
43+
44+
## Runtime
45+
46+
Home, docs previews and exports share a verified Orbit snapshot. Its manifest
47+
records source revision and hashes because npm currently has the same version
48+
number with older code. Astro/Starlight build the site; interactions use plain JS.
49+
50+
## Verification
51+
52+
Validated against the production build on 2026-09-05:
53+
54+
- Node 24 type checking and production build pass; npm audit reports no vulnerabilities.
55+
- All 60 existing routes and 101 local link/asset targets resolve, including anchors.
56+
- Chromium, Firefox and WebKit pass the playground and documentation editor flows.
57+
First pointer and keyboard edits work in WebKit without focusing or scrolling on load.
58+
- All nine recipe/browser exports run from `file://` without network access;
59+
Chromium clipboard content matches the downloaded HTML. Export failures recover.
60+
- Keyboard tabs, reset, zero/full values, 80 satellites and reduced motion work.
61+
- Desktop, tablet and mobile layouts were visually inspected. No horizontal page
62+
overflow at 360, 390, 768, 1280 or 1440 pixels. Search and mobile navigation work.
63+
- Both copies of all five Orbit runtime files match the recorded SHA-256 hashes.
64+
65+
User revision checks:
66+
67+
- The header and hero load the original docs SVG, with its existing color and proportions.
68+
- UI text and compositions use Arial. Monospace remains only in source code;
69+
section/tab numbering and promotional slogans were removed.
70+
- The hero's seven depth layers tilt automatically on an 18-second loop.
71+
Chromium, Firefox and WebKit pass pause/resume, satellite changes, offscreen
72+
suspension, persistent manual pause and initial/live reduced-motion checks.
73+
- Nine animation phases at 360, 390, 768 and 1440 pixels produce no horizontal
74+
page overflow. Desktop, tablet and mobile views were inspected visually.
75+
- The tablet preview reserves space below the composition for its caption.
76+
- The hidden-tab handler was checked by simulating document visibility in
77+
headless browsers; pagehide/pageshow suspension was also checked.
78+
79+
Release boundary: this is a local site build. The bundled Orbit snapshot includes
80+
the fixes; the existing npm 1.4.12 release does not. Publish a new package version
81+
and run `npm run sync:orbit` before removing the pending-release documentation.

0 commit comments

Comments
 (0)