refactor: remove section dividers
7642ee7
Update Solarxy v0.6.0 wiki docs
208c218
FAQ #14 + Release-Notes See-also + author-attribution dedup
Final consistency pass before screenshot capture. Closes the cross-page
consolidation loop the Phase 4 plan called for and addresses the only
content page that was missing a See-also footer.
- FAQ.md gains entry #14: "Why are my annotations anonymous?" Links out
to Review System -> Author attribution for the design rationale.
- Troubleshooting.md shortens its author-attribution section to a
one-line cross-link into the new FAQ entry, removing the in-line
restatement.
- Release-Notes.md gains a See-also footer.
Consistency sweep results across the wiki:
- All 21 content pages carry the top breadcrumb (Home intentionally
exempt; chrome files _Sidebar / _Footer exempt).
- All content pages now carry a See-also footer.
- Zero stale "Phase N" / "Coming in Phase" / TODO leak-throughs.
- Zero em-dashes / en-dashes / smart quotes.
- Zero broken internal page links.
- All 14 FAQ anchors valid.
1d6d5a8
Fix stale User-Guide anchors after the Phase 1 split
A verification pass ahead of screenshot capture turned up two anchor
links that went stale when the Phase 1 restructure moved content out
of User-Guide:
- Configuration.md: User-Guide#preferences -> Interface#preferences
(Preferences section moved to Interface during the User-Guide
split).
- Review-System.md: User-Guide#dockable-layout ->
Interface#dockable-layout (same root cause).
Also confirmed clean across every other dimension:
- Em-dash / en-dash / smart-quote sweep: zero matches across all 23
wiki pages.
- Mermaid block balance: 14 blocks across 11 files, every opening
fence matched by a closing fence.
- Internal page-link audit: all 23 pages exist; zero broken page
targets.
- Code-citation spot check on five validation claims
(default_tolerance_percent, default_flipped_normal_dot, the normals
check severities, the manifold check severities and allow_open_mesh
modifier, the UV format gate): all match the v0.6.0 code.
abc3e1c
Polish pass across pre-existing pages
Cross-page consolidation and per-page touch-ups identified by the v0.6.0
milestone audit. No new pages, no new diagrams.
Keyboard-Shortcuts: turned the "user-remappable shortcuts" inline
sentence into a Note callout that also points readers to the in-app ?
overlay.
CLI-Reference: replaced the standalone Configuration discovery section
with a one-paragraph summary plus a cross-link to Configuration ->
Discovery order. Added an annotated line-by-line --paths invocation in
the Batch validation section so the worked example sits alongside the
flag table.
Troubleshooting: dropped the duplicate --paths / --mode analyze
explanation in favour of cross-links to CLI Reference and CI/CD
Integration. Added an "Approximate, GPU-bound" callout above the
Performance tips table; clarified that the console's solarxy=trace
default is not user-configurable in-app (use RUST_LOG=...). Linked the
materials / textures section to User Guide -> Supported file formats.
Release-Notes: expanded the Shift+S retirement bullet to mention that
plain S now resets the active pane to Shaded mode. Expanded the FPS
HUD removal bullet to mention Window -> Status Bar. Tightened the Ayu
Mirage paragraph into a bulleted list.
Contributing: clarified the wiki contribution flow (clone
solarxy.wiki.git, edit on develop, push to master; wikis do not accept
PRs). Reworded "every page has a See also footer" to "most major
pages."
Installation: added an "After installing, see Quickstart" pointer near
the top. Cross-linked solarxy-cli --update to CLI Reference's
Self-update section.
CI-CD-Integration: added a "When to use the Docker image" paragraph
before the tag table. Standardized the GitHub Actions / GitLab CI /
Jenkins intros to name both the trigger and the result; Perforce intro
already in shape.
2653b3c
Add 10 Mermaid diagrams across the wiki
Ten unique Mermaid flowcharts placed at 14 locations across 11 pages,
all using the Ayu Mirage Dark palette matched to the app. Mermaid
renders natively in GitHub wiki pages; no rendering pipeline.
Diagrams:
- Render pipeline (10 stages, MSAA boundary) -> Architecture, Inspection.
- Validation dispatch (merged: 9 checks, order + severity + toggles)
-> Validation-Reference, Tutorial-Custom-Validation-Policy.
- Stale anchor lifecycle -> Review-System,
Tutorial-First-Review-Session.
- Inspection mode decision tree -> Tutorial-Inspect-A-Gltf.
- solarxy-cli dispatch (view/analyze, with/without --paths) ->
Tutorial-Validate-In-CI.
- Dock layout state (default / last / saved transitions) -> Interface,
Architecture.
- Review-mode click ladder (3-rung priority chain) -> Review-System.
- Config discovery (4-step priority ladder) -> Configuration.
- CI adapter and format selection -> CI-CD-Integration.
- 7-crate dependency DAG -> Architecture (replaces the ASCII version).
Each diagram lands at the start of its most-relevant section, before
the prose, with a one-line italic caption underneath. Density is
medium: decision branches and edge labels included; no over-detailed
note blocks.
The plan's separate Diagrams #2 and #9 were merged into one validation
flow per the locked decision. Phase 3 placeholder markers
("Phase 3: Mermaid Diagram N ...") cleaned up from Architecture.
9a97f74
Fill Validation Reference, Architecture, and FAQ
Validation-Reference (~340 lines):
- Worked example for the triangle-budget tolerance band, grounded in
the default 20% formula.
- In-viewport overlay section names the six colour categories sourced
from solarxy-renderer/src/validation.rs: red Error, orange
InvalidMaterial, cyan NormalMismatch, magenta MissingUvs, yellow
DegenerateTriangles, orange-red NonManifoldEdge (edges only, 60%
alpha vs 40% for faces). Notes that triangle_budget has Model scope
and does not paint.
- Analyze TUI Validation-tab keys table.
- Per-check reference: nine H3 subsections (one per check), each with
the five-block template - What it flags / Severity + Toggle / Common
causes / How to fix / Overlay appearance. Fix guidance stays
DCC-agnostic.
Architecture (~190 lines):
- Lean contributor on-ramp: crate map, dependency DAG (ASCII; Mermaid
in Phase 3), the ten-stage render pipeline, State / GuiSnapshot
orientation, dock layout persistence, validation library boundary,
where-to-look table.
- Every file path links to GitHub source at the v0.6.0 tag for
clickable navigation; updates per release.
- Links to in-repo CLAUDE.md for the deeper code-side patterns rather
than reproducing them in the wiki.
FAQ (~180 lines):
- 13 entries ordered by guessed frequency (hottest first): --paths +
--mode analyze, markers disappeared after re-export, which
solarxy.toml was used, shading vs inspection, Shift+S retirement,
amber Review dot, in-app shortcuts, theme hot-swap, texel density
red, markers in UV pane, F4 Quad and UV Map, no CLI MSI on Windows,
no Linux aarch64 AppImage in v0.6.0.
- Each answer: one short paragraph + deep link. Anchor ids kept from
the Phase 1 scaffold so cross-page links stay stable.
13671ba
Write Quickstart and four tutorial pages
Fill the Phase 1 scaffolds with full prose. Each page uses the hybrid
format: short scenario opening, numbered steps with inline screenshot
TODOs, then Verify / What you learned / Where to go next.
Quickstart (~170 lines):
- Five-minute path from install to first saved review marker.
- Khronos DamagedHelmet.glb as the working asset.
Tutorial: First review session (~225 lines):
- Reviewer-side narrative through the full anchor-stability loop.
- FlightHelmet recommended for multi-mesh re-anchor practice; falls back
to DamagedHelmet for single-file simplicity.
- Walks the click ladder, the four categories, threading, sidecar save,
re-export, Needs re-anchor, manual Re-place.
Tutorial: Inspect a glTF for delivery (~200 lines):
- Artist-side QA narrative. Cycles every inspection mode (1-7), the
wireframe overlay with all three weights, Outliner mesh isolation,
Analyze TUI.
Tutorial: Validate in CI (~210 lines):
- Pipeline-engineer narrative from local solarxy.toml to GitHub Actions
PR annotations to SARIF Code Scanning.
Tutorial: Build a custom validation policy (~210 lines):
- TD narrative for authoring solarxy.toml from scratch on a
representative asset folder. [budgets], [[filenames.rules]],
[validation], [thresholds], iteration loop.
DCC tool guidance stays tool-agnostic throughout. All sample assets
reference the Khronos glTF Sample Assets repo. Plain ASCII punctuation.
e0f11f2
Restructure wiki: split User-Guide and Configuration, scaffold new pages
Phase 1 of the comprehensive v0.6.0 milestone wiki plan. Pure restructure -
no new prose - to land the 21-page layout. Phase 2 fills the scaffolded
sections.
New pages (10):
- Quickstart, Tutorial-First-Review-Session, Tutorial-Inspect-A-Gltf,
Tutorial-Validate-In-CI, Tutorial-Custom-Validation-Policy: scaffolds
with TOCs and Phase 2 placeholders.
- Interface, Inspection: split out of User-Guide. Interface holds the
menu bar / pane toolbars / sidebar / dock / status bar / viewport
layouts / loading / console / preferences. Inspection holds view +
inspection modes, material overrides, Material Inspector, lighting,
post-processing, display overlays, mesh visibility, camera.
- Validation-Reference: split out of Configuration. Holds the nine-check
table and thresholds; Phase 2 fills the deeper per-check and overlay
sections.
- FAQ: ten seed questions with anchored stubs.
- Architecture: section stubs with the crate table and the
where-to-look-for-X map.
Modified pages (3):
- User-Guide: shrunk to a hub overview that points to Interface,
Inspection, and the tutorials. Two binaries and supported file formats
stay.
- Configuration: Validation checks block removed and replaced with a
pointer to Validation-Reference. Discovery, schema, field reference,
and the entire config.toml section are unchanged.
- _Sidebar: rebuilt for the 21-page navigation in six sections.
77c4a57
update: 0.6.0 release notes first draft
fb6486e
Update wiki pages to align with 0.5.0 milestone release
7183d53
Destroyed CLAUDE (markdown)
f39cf43
Updated Solarxy (markdown)
0280989
Updated Contributing (markdown)
b6ecfe7
Updated Troubleshooting (markdown)
6a58a14
Updated Keyboard Shortcuts (markdown)
838e2dc
Updated CLI Reference (markdown)
e599ffe
Updated User Guide (markdown)
6ea65d0
Updated Installation (markdown)
390fc5f
Updated Release Notes (markdown)
34c1058
Updated Release Notes (markdown)
777af11
Updated Release Notes (markdown)
ca8c1fb
Updated Release Notes (markdown)
581269e
Updated Release Notes (markdown)
d376725
Updated _Footer (markdown)
548c29b