obsidian-plugin/flash555588_ai-model-workbench
1
0
Fork 0
mirror of https://github.com/flash555588/ai-model-workbench.git synced 2026-07-22 06:56:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
flash555588_ai-model-workbench/docs
History
flash555588 6c088e2ac1 Release 0.7.6
2026-07-12 23:28:52 +08:00
..
assets docs: replace preview image with local GIF 2026-06-08 13:21:37 +08:00
release-notes Release 0.7.6 2026-07-12 23:28:52 +08:00
0.6.0-plus-upgrade-plan.md Add configurable auxiliary conversion folder 2026-06-27 20:58:17 +08:00
ai-3d-plugin-design-report.md chore(P2): normalize line endings, add .editorconfig, run lint in CI, sync docs 2026-06-15 17:01:17 +08:00
common-usage-syntax.md Add configurable auxiliary conversion folder 2026-06-27 20:58:17 +08:00
common-usage-syntax.zh-CN.md Add configurable auxiliary conversion folder 2026-06-27 20:58:17 +08:00
cross-platform-development.md feat: improve mobile support and cross-platform portability 2026-05-12 23:02:33 +08:00
demo.md Split README usage docs 2026-06-26 18:35:31 +08:00
development-handoff.md Release 0.7.6 2026-07-12 23:28:52 +08:00
mit-upstream-guidelines.md release: simplify model view and publish 0.2.1 2026-05-25 20:42:41 +08:00
preview-interaction-matrix.md Release 0.7.5 2026-07-12 22:20:45 +08:00
preview-routing-matrix.md Release 0.7.0 2026-06-28 00:35:20 +08:00
README.md Release 0.7.6 2026-07-12 23:28:52 +08:00
requirements-tracker.md Release 0.7.5 2026-07-12 22:20:45 +08:00
threejs-migration-roadmap.md feat: upgrade three preview fidelity 2026-06-25 20:23:47 +08:00
usage-guide.md Release 0.7.5 2026-07-12 22:20:45 +08:00
usage-guide.zh-CN.md Split README usage docs 2026-06-26 18:35:31 +08:00
workbench-3dgrid-feasibility-note.md release: prepare 0.2.3 2026-05-29 16:33:42 +08:00

README.md

Documentation Index

Use this page to choose the right document before changing code.

Start Here

  • ../AGENTS.md - coding-agent working rules, tool setup, and change-to-test mapping.
  • development-handoff.md - current architecture, product contract, specification map, and handoff checklist for a new model or developer.
  • ../CLAUDE.md - Claude Code entry point that points back to the shared handoff docs.

Product And Architecture Specs

  • usage-guide.md - user workflow guide for preview surfaces, direct view, annotations, measurements, knowledge notes, conversion, and troubleshooting.
  • common-usage-syntax.md - copy-paste syntax for wikilink embeds, 3d blocks, 3dgrid blocks, common fields, supported extensions, and shortcuts.
  • usage-guide.zh-CN.md - Simplified Chinese usage guide.
  • common-usage-syntax.zh-CN.md - Simplified Chinese syntax reference.
  • preview-routing-matrix.md - canonical Three/Babylon routing contract and smoke tests.
  • 0.6.0-plus-upgrade-plan.md - staged upgrade plan for the 0.6.0+ reliability, workflow, and maintainability releases.
  • requirements-tracker.md - stable product requirements, statuses, acceptance criteria, and verification mapping.
  • threejs-migration-roadmap.md - Three.js migration history, target state, and reopen conditions.
  • workbench-3dgrid-feasibility-note.md - why production workbench and 3dgrid remain conservative capability paths.
  • ../FORMAT_SUPPORT_DESIGN.md - format support and local conversion strategy.
  • ai-3d-plugin-design-report.md - early product/design background.
  • demo.md - broad legacy walkthrough; prefer usage-guide.md and common-usage-syntax.md for current user-facing guidance.

Engineering Guardrails

  • cross-platform-development.md - vault/filesystem path rules, converter discovery, and platform diagnostics requirements.
  • mit-upstream-guidelines.md - license boundaries for upstream code or ideas.
  • ../SECURITY.md - release token safety and PAT leak response.

Release And Verification References

  • ../README.md - user-facing install, format support, verification, and release notes.
  • ../README.zh-CN.md - Simplified Chinese user-facing docs.
  • ../CHANGELOG.md - current unreleased and release history.
  • release-notes/0.6.0-plus.md - user-facing rolling update log for the 0.6.0+ release line.
  • release-notes/0.7.6.md - GitHub release notes for the Babylon timer source-review patch.
  • release-notes/0.7.5.md - GitHub release notes for the Slice and measurement interaction release.
  • release-notes/0.7.1.md - GitHub release notes for the 0.7.1 source-review patch.
  • release-notes/0.7.0.md - GitHub release notes for the 0.7.0 compatibility release.
  • release-notes/0.6.1.md - GitHub release notes for the 0.6.1 source-review patch.
  • release-notes/0.6.0.md - GitHub release notes for the 0.6.0 capability-tree release.
  • ../.github/workflows/release.yml - release asset publishing workflow.

Quick Selection Guide

If you are changing... Read first
Renderer route, rollout, annotation preview preview-routing-matrix.md
User-facing examples, common syntax, or workflow docs usage-guide.md, common-usage-syntax.md
0.6.0+ release planning or upgrade sequencing 0.6.0-plus-upgrade-plan.md
Product scope, requirement status, release gates requirements-tracker.md
Three.js migration or workbench route policy workbench-3dgrid-feasibility-note.md
3dgrid behavior or presets workbench-3dgrid-feasibility-note.md, demo.md
Supported formats or conversion ../FORMAT_SUPPORT_DESIGN.md, cross-platform-development.md
Generated reports, indexes, part notes development-handoff.md, ../README.md Knowledge Notes
Persisted state, settings migration development-handoff.md, ../AGENTS.md
Release publishing or token handling ../SECURITY.md, ../README.md Release Publishing