Skip to content

docs(samples): add visual walkthroughs and a sidebar-driven website - #184

Draft
VPDPersonal wants to merge 21 commits into
mainfrom
docs/add-sample-visuals
Draft

docs(samples): add visual walkthroughs and a sidebar-driven website#184
VPDPersonal wants to merge 21 commits into
mainfrom
docs/add-sample-visuals

Conversation

@VPDPersonal

Copy link
Copy Markdown
Owner

Summary

  • 📝 Every sample gets a visual walkthrough: theme-aware media (light/dark) in dedicated Documentation/ folders, a new Samples~/README.md overview (+ 🇷🇺) in the recommended learning order, and sharper intro / feature-table wording in the root and package READMEs.
  • ✨ Sample demos polished to match the visuals: refined layouts, geometry and palettes, continuous surface trails, bundled demo fonts, code aligned with project standards.
  • ✨ Website: sidebar navigation panel on desktop and a full-width drawer on mobile, client-side search, samples overview and API sidebar, unified 2px rounded frames, last-updated date, click ripple on the dot canvas, compact footer.
  • 🐛 Website fixes: only the current theme's sample media is emitted in production builds; mobile table of contents no longer overlaps content; Samples~/README links rewrite to /tutorials.
  • 🔧 Launch configs for the website dev servers.

Notes for review

  • Large diff (~325 files) is mostly media and the Docusaurus site; the package code changes are confined to Samples~.
  • crossInstanceLinks.js gained a rule for the new samples index — worth a glance to make sure no sample README link regresses.
🇷🇺 Кратко
  • 📝 У каждого сэмпла появился визуальный туториал: медиа под светлую и тёмную тему, обзор Samples~/README.md (+ ru) в рекомендуемом порядке изучения, переписаны вступление и таблица фич в README.
  • ✨ Демо-сцены доведены до соответствия визуалам: раскладка, геометрия, палитры, шлейфы по поверхностям, встроенные шрифты.
  • ✨ Сайт: боковая панель навигации на десктопе и полноэкранная на мобильных, клиентский поиск, обзор сэмплов и API-сайдбар, единые рамки 2px, дата обновления, ripple по клику, компактный футер.
  • 🐛 Правки сайта: в продакшене только медиа текущей темы, оглавление на мобильных не перекрывает контент, ссылки на Samples~/README ведут на /tutorials.
  • 🔧 Launch-конфиги для dev-серверов сайта.

VPDPersonal and others added 19 commits September 8, 2026 14:27
- add localized screenshots and demos to all package samples
- preserve tutorial routes and localized asset synchronization
- refine sample behavior to match the documented walkthroughs
- Redesign Unity sample scenes and the ability catalog.
- Capture matching light and dark covers and animated demonstrations.
- Add a localized sample gallery and switch media with the website theme.
- Remove duplicate article covers and decorative GIF text.
- Replace footprints with a wider trail that changes color at tile boundaries.
- Improve capture quality and harmonize light and dark accent palettes.
Keep enemies above the arena, align surface trails, and slow soft sand.
Use rectangular platforms and anchor volume guides to the orbit boundary.
Align catalog fields and buttons, refresh both media themes, and shorten pauses.
Unify the sample order across Unity and the documentation site.
Improve catalog previews, logo proportions, Welcome guidance and contacts.
Give each EnumValues surface a distinct trail color and refresh its media.
- remove "ASPID FASTTOOLS / SAMPLE LAB" and per-sample feature captions from all scenes and the EditorTools window
- re-lay title, subtitle and instruction by ortho-size fractions shared across samples; widen title–subtitle gap
- align ProfilerMarkers margins and label sizes with the other samples

Co-Authored-By: Claude <noreply@anthropic.com>
- Sidebar wraps into a pinned header (brand, section switcher, search),
  scrolling list and pinned footer (GitHub, Asset Store, language, theme)
- Changelog gets a generated versions sidebar with heading anchors
- Site footer closes the article column; breadcrumbs disabled
- In-article TOC disclosure restyled as a quiet mono label

Co-Authored-By: Claude <noreply@anthropic.com>
- Each sample ships IBM Plex and iA Writer Quattro with licenses so
  demo UIs render identically on any machine; EditorTools loads them
  through SampleFonts.uss
- EnumValues drops the unused Cyan/Grid materials and updates the demo
  GIFs and READMEs
- Adds the Ayu Light dev-only editor theme under Assets/DevTools

Co-Authored-By: Claude <noreply@anthropic.com>
- Locale-aware search index plugin with a Cmd/Ctrl+K dialog and tests
- Samples section opens with a themed gallery overview page
- Main docs sidebar becomes explicit groups; API sidebar adapts DocFX
  labels; theme palette and image handling refined

Co-Authored-By: Claude <noreply@anthropic.com>
…panel

- move backdrop-filter off .navbar: it made the fixed drawer clip to the navbar height
- share header, section switcher, search and footer between the desktop sidebar and the drawer
- replace the hover-only locale dropdown with a click-toggled one that works on touch

Co-Authored-By: Claude <noreply@anthropic.com>
…nk highlight

Co-Authored-By: Claude <noreply@anthropic.com>
…ghts

Co-Authored-By: Claude <noreply@anthropic.com>
- Admonitions, code blocks, tables, pagination cards, sample cards and the reading panel share a 12px radius and 2px border; :::note is blue like :::info
- Chip padding no longer leaks into <pre>, so the copy button fits inside the block
- "Edit this page" becomes a pencil in the column's top-right margin with the last-updated date on the left; sync-i18n stamps last_update.date from git for untracked copies
- Sidebar headers, section switcher and search button use the code background; the samples overview regains its Next link
…d panels

- Sidebar and TOC content now share the article card's top and bottom edges
- Edit links resolve for every locale; footer is one centred row of contacts (X replaces Asset Store)
- Pagination cards use the accent green; empty-canvas clicks send a canvas-drawn wave through the dots

Co-Authored-By: Claude <noreply@anthropic.com>
…n builds

- cssnano merged the identical display:block rules and reordered them after display:none, so both dark and light images appeared
- hide via specificity (html:not([data-theme='light'])) instead of relying on source order

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- New Samples~/README.md (+ ru) listing every sample in learning order
- Rewrite intro and feature table wording in root and package READMEs
- Move the samples section out of getting-started into the new overview
- Website: rewrite Samples~/README links to /tutorials

Co-Authored-By: Claude <noreply@anthropic.com>
@VPDPersonal VPDPersonal added type: documentation Documentation only status: work-in-progress Draft / not ready for review area: samples Sample projects area: docs Repository documentation (README, CHANGELOG, docs/) labels Sep 12, 2026
Unify the GitHub README and bilingual documentation with automatic synchronization.

Add Unity captures and concise code examples, refine page layout and badges, and simplify installation and quick start guidance.

Use default script icons for sample weapons and retain media capture sources.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Repository documentation (README, CHANGELOG, docs/) area: samples Sample projects status: work-in-progress Draft / not ready for review type: documentation Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant