Skip to content

feat: add interactive samples and documentation site - #40

Draft
VPDPersonal wants to merge 3 commits into
mainfrom
codex/samples-and-website
Draft

VPDPersonal wants to merge 3 commits into
mainfrom
codex/samples-and-website

Conversation

@VPDPersonal

@VPDPersonal VPDPersonal commented Nov 7, 2026 •

Copy link
Copy Markdown
Owner

Important

  • Enable repository Pages → Source → GitHub Actions before publishing the website. GitHub currently returns no Pages site for this repository.

Why

The previous samples did not provide a focused, ready-to-run introduction to observable collections, and Collections lacked a documentation website matching Aspid.FastTools. This adds five practical scenes with fewer on-screen explanations and makes their guides, previews, and API reference available in one bilingual site.

What

  • Replace five samples with self-contained, importable UI Toolkit scenes.
  • Add light/dark themes, flexible card rows, and collapsed event details.
  • Provide paired Unity screenshots and practical guides for every sample.
  • Add English/Russian documentation, API reference, search, and interactive examples.
  • Build documentation in PRs and publish GitHub Pages from main.

Start with: Aspid.Collections/Packages/tech.aspid.collections/Samples~/README.md, then Website/README.md

Squad Roster

Dark Light
Squad Roster in dark theme Squad Roster in light theme
Equal-width cards with matching 24px outer insets at 1600×1000. The same aligned row with the light palette.
More sample screenshots: dark and light

Item Browser

Dark Light
Item Browser in dark theme Item Browser in light theme
Search, category filters, sorting, and item cards. The same catalogue with the light palette.

Crafting Queue

Dark Light
Crafting Queue in dark theme Crafting Queue in light theme
Pending orders and completed-order undo. The same two lanes with the light palette.

Match Scoreboard

Dark Light
Match Scoreboard in dark theme Match Scoreboard in light theme
Scores keyed by player ID, with stable row views. The same initial scores with the light palette.

Zone Occupancy

Dark Light
Zone Occupancy in dark theme Zone Occupancy in light theme
Unique visitors and a detachable alarm subscription. The same visitors with the light palette.
Website screenshots: desktop and 375px
Desktop: dark Desktop: light
Documentation gallery on desktop in dark theme Documentation gallery on desktop in light theme
Sample previews follow the dark website theme. Sample previews follow the light website theme.
375px: dark 375px: light
Documentation gallery at 375px in dark theme Documentation gallery at 375px in light theme
Single-column gallery with compact navigation. The same mobile layout in the light theme.
Verification
  • Import all five samples and compile in Unity 6000.6.5f1 → passed.
  • Unity Editor sample checks → 322 assertions passed: actions, disposal, re-enable, defaults, themes, expanded layout, and scrolling.
  • Real Unity captures → all five scenes in both themes at 1600×1000 and 1024×768; theme switching preserves card identities.
  • Website: npm ci, npm run sync-content, npm run check-content, npm test, npm run build → 47 tests passed; English and Russian builds passed.
  • Browser: desktop and 375px gallery, theme-aware previews, tutorial images, and image zoom → passed; no console errors.
  • actionlint .github/workflows/docs.yml and git diff --check → passed.
  • Responsive card layout → 27 stages passed: add/remove/filter, partial rows, singleton, equal widths, 16px gutters, and wrapping across wide, two-column, and single-column layouts.
  • Outer alignment in Unity at 1600×1000 → 24px left and 24px right with the scrollbar hidden; visible scrollbar width is measured separately.
  • Unity verification covers Editor execution; player and IL2CPP builds were not run.
Context

The new scenes replace the previous five sample entries and remain Unreleased; published package 1.1.1 does not contain them yet. The development manifest includes the built-in UI Toolkit module. Runtime collection code is unchanged. The website deployment runs after merge to main once GitHub Pages is configured.

- Replace the previous samples with five focused UI Toolkit scenes.
- Add light and dark themes, concise controls, and paired Unity previews.
- Add bilingual documentation, generated API pages, and GitHub Pages CI.
- Grow cards equally across rows and wrap from a flexible basis.
- Refresh light and dark Unity previews for the sample guides.
- Remove the one-sided padding from sample scroll containers.
- Refresh paired Unity previews after checking outer edge alignment.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant