Files
prometeu-studio/docs/specs/studio/README.md

87 lines
3.5 KiB
Markdown

# Studio Specs
This directory contains the normative Studio specification set.
## Purpose
Specs define the official Studio contract.
They exist to stabilize:
- the application shell,
- workspace responsibilities,
- interaction flows,
- service and event integration expectations,
- UX behavior that implementation should preserve.
## Expected Format
The exact structure may vary by document, but a Studio spec should usually contain:
1. Title
2. Status
3. Scope or Applies To
4. Purpose
5. Authority and Precedence
6. Normative Inputs
7. Core Rules
8. Non-Goals
9. Exit Criteria
## Writing Rules
- Write in normative language.
- Integrate only decisions that have already been closed.
- Keep design exploration and option analysis out of the spec body.
- Preserve clear boundaries between shell, workspace, and integration specs.
## Upstream Rule
Specs should normally be fed by:
1. agendas that frame the open Studio topic,
2. decisions that close the product or interaction choice,
3. plans that define propagation,
4. then spec integration.
If a spec edit would require guessing unresolved UI behavior, stop and surface the missing decision first.
## Current Corpus
The current Studio core corpus is:
1. [`1. Studio Shell and Workspace Layout Specification.md`](1.%20Studio%20Shell%20and%20Workspace%20Layout%20Specification.md)
2. [`2. Studio UI Foundations Specification.md`](2.%20Studio%20UI%20Foundations%20Specification.md)
3. [`3. Studio Components Module Specification.md`](3.%20Studio%20Components%20Module%20Specification.md)
4. [`4. Assets Workspace Specification.md`](4.%20Assets%20Workspace%20Specification.md)
5. [`8. Project-Local Studio State Specification.md`](8.%20Project-Local%20Studio%20State%20Specification.md)
6. [`9. Studio Core and Adapter Architecture Specification.md`](9.%20Studio%20Core%20and%20Adapter%20Architecture%20Specification.md)
7. [`10. DEV and Automation Specification.md`](10.%20DEV%20and%20Automation%20Specification.md)
8. [`11. MCP Tools and Project Knowledge Contract.md`](11.%20MCP%20Tools%20and%20Project%20Knowledge%20Contract.md)
## Reading Order
Recommended order:
1. shell and workspace layout;
2. shared UI foundations;
3. components module policy;
4. assets workspace behavior;
5. project-local Studio state behavior;
6. Studio Core, adapter, composition, and external integration boundaries;
7. DEV authority, document handoff, automation operations/captures and phased integration gates;
8. MCP transport/tool schemas and project/language knowledge contracts.
## Current Wave Notes
The embedded Studio code-editor stack was removed by `DEC-0031`.
Normative reminders:
- the accepted Studio workspace corpus is `Assets`, `Debug`, `Shipper`, and `DEV`; the DEV implementation follows DEC-0060's phased delivery;
- project-local Studio session state remains normative and is owned by `StudioProjectSession`;
- DEC-0060 authorizes an external coding agent using native file tools and the existing project LSP through MCP; it does not reinstate the embedded editor or authorize a replacement language-service architecture;
- the Studio backend is exposed through neutral API contracts shared by JavaFX and the local MCP adapter, without duplicated authority or orchestration;
- Spring Boot remains the desktop composition root with the narrow DEC-0060 local MCP HTTP exception; Spring Modulith still verifies the JavaFX-free `p.studio.core` boundary;
- `p.studio.Container`, `AppContainer`, and the mixed `prometeu-studio` module are not valid final architecture.