docs(samples): add visual walkthroughs and a sidebar-driven website - #184
Draft
VPDPersonal wants to merge 64 commits into
Draft
VPDPersonal wants to merge 64 commits into
VPDPersonal wants to merge 64 commits into
Conversation
- 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
added
type: documentation
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.
- Rename display name helpers, unify null results and pool component lists - Add eight editor checks and update samples and generated API references - Refine Russian guides and fix full-width documentation tables
Add AndApplyWithoutUndo variants and editor tests for serialized property setters. Refresh API reference, changelogs, and English and Russian usage guides. Render before/after code tables with consistent cell backgrounds.
- Expand and revise English and Russian feature documentation - Refresh the Profiler capture and add responsive background windows - Refine C# preprocessor highlighting and include current helper edits
- merge scope and custom-name sections, drop generated-code sample - shorten generation details, remove duplicate sample link Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- New remark plugin inserts <ArticleToc /> after the H1 on every docs instance; the introduction has no H1 and loses the disclosure - Collapsed row shows "Contents · N sections"; the list opens in two columns - Layout no longer renders the stock mobile TOC above the article Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ion without one Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Between 997 and 1400px the right column is hidden; a pinned corner button now opens a popover with the desktop outline instead of the disclosure at the top of the article. Section click, Esc and outside click close it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The stock disclosure above the article is gone on every width; below 997px the corner button sits closer to the edge and the popover fits the viewport. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… one Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- one-sentence lede and a plainer Tooling row in both languages - the site imports the banner GIF from docs/images instead of raw GitHub - code previews in the feature cards drop to 16:9 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
GitHub drops <br /> inside <pre lang> while highlighting, collapsing every before/after example into one line. A entity survives highlighting and the site's remark plugin reads it as a newline unchanged. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
On GitHub the three-column table squeezed the captures and code; each feature is now a linked heading, one sentence and a fenced preview. The site builds the same card grid from these sections. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- scripts/serve-all.sh rebuilds both locales and serves them detached so every agent shares one server - docs-site skill now requires rerunning the script after each change instead of dev servers Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- the lede now names the concrete tools instead of a generic phrase - the site derives the page description from the new lede and lets it span the column Co-Authored-By: Claude <noreply@anthropic.com>
- the lede sells the package instead of repeating the feature cards; the language link is gone from the link row - Quick start imports samples through the Welcome window; the other install options show full Git URLs - the EnumValues card uses the package's own GIF instead of the sample's PNG - scripts/set-version.sh bumps package.json, the badge and both READMEs; the release workflow checks they match Co-Authored-By: Claude <noreply@anthropic.com>
- Installation moves ahead of Features so the Git URL is one scroll away - feature captures are sized <img> tags; the site turns them back into card previews Co-Authored-By: Claude <noreply@anthropic.com>
remark-stringify escaped the bracket in `> [!WARNING]`, so GitHub rendered the note as a plain blockquote. Co-Authored-By: Claude <noreply@anthropic.com>
GitHub does not render alerts inside <details>, so the warning showed as a plain quote. Co-Authored-By: Claude <noreply@anthropic.com>
…ture again Co-Authored-By: Claude <noreply@anthropic.com>
…es dev test - Rewrite pages 07–09 (en + ru) with tighter wording, GitHub alerts and a static example table; drop the stale editor-helpers PNG and visual-element GIF - Replace the DocsMedia Loadout fixture with IWeapon/Pistol/PlasmaRifle/Shotgun fixtures and IMGUI + UI Toolkit SerializeReferences dev tests - Remove the AyuLight dev theme, add DevTests/README.md - Website: let demo captures on the visual-element page use the full article width Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ctical example Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- rework the EnumValues and editor-helpers docs in both locales - drop the inherited-attribute note from GetDisplayName - adjust the Docusaurus config, remark plugins, styles and i18n sync - remove the unused analyzers sample file Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…e-page rules - rebuild the page on one AbilityBook example with result tables, in both locales - tighten the lead paragraphs of SerializedProperty Extensions and Editor Helpers - add the confirmed feature-page writing rules to the docs-site skill - rename CLAUDE.md to AGENTS.md and carry the pending site CSS tweak Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- trim the VisualElement and SerializedProperty pages in both locales - align the drawer close button with the search button - adjust the intro banner remark plugin Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- drop scenario intros, code comments and paragraphs that explain Unity behaviour - remove composed examples and per-element demo chains; unfold API spoilers - rewrite custom USS section as a TryGetByEnum before/after table - fill empty BaseField / IMixedValueSupport spoilers, drop the Next steps block Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…al sample section - quick start now uses FlockSimulation like the rest of the page - Profiler screenshot replaces the ASCII tree; the duplicate "Result in Profiler" section becomes a one-line "Package sample" - collapsible generated-code example under Step(); line-number and ENABLE_PROFILER bullets shortened - drop the using/IDisposable semantics sentence (Unity behaviour, not FastTools) Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
- Light palette moves from beige to cool grey canvas with white surfaces; Prism light follows - Ripple crests read a dedicated --venom-ripple colour so risen dots are a highlight on light grey - Admonition windows in light use a translucent paper tint; heading and icon take the block colour in both themes Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…nd Editor Helpers - EnumValues: own captures for quick start, Populate and the type selector; variant table gets a "key in GetValue" column; flag lookup shown as three-step cards, results table dropped; enum-change outcomes as a table; WARNING about the inspector resetting unresolved keys - ProfilerMarkers: Marker() and WithName() sections; Editor Helpers: headings named after the methods - docs-site skill: package-sample section may carry the sample demo GIF Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Add shared scene palettes and a theme selector for Ability Catalog. Refresh light GIFs and previews for all five samples. Preserve original recordings and reproducible capture recipes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation/folders, a newSamples~/README.mdoverview (+ 🇷🇺) in the recommended learning order, and sharper intro / feature-table wording in the root and package READMEs.Samples~/READMElinks rewrite to/tutorials.Notes for review
Samples~.crossInstanceLinks.jsgained a rule for the new samples index — worth a glance to make sure no sample README link regresses.🇷🇺 Кратко
Samples~/README.md(+ ru) в рекомендуемом порядке изучения, переписаны вступление и таблица фич в README.Samples~/READMEведут на/tutorials.