Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editor documentation for Engine V2 #691

Merged
merged 22 commits into from
Jan 20, 2025
Merged

Editor documentation for Engine V2 #691

merged 22 commits into from
Jan 20, 2025

Conversation

kpal81xd
Copy link
Contributor

@kpal81xd kpal81xd commented Jan 16, 2025

Overview

  • Added documentation for Editor V2

Preview

Engine Compatibility

image
image

Editor Migrations

image

@kpal81xd kpal81xd self-assigned this Jan 16, 2025
@kpal81xd kpal81xd requested a review from a team January 16, 2025 11:29
@Maksims
Copy link
Collaborator

Maksims commented Jan 16, 2025

Please, don't call it Editor V2, there is nothing for it to be called V2.

@mvaligursky
Copy link
Contributor

mvaligursky commented Jan 16, 2025

I would suggest a reorg into two separate pages.


  • I would call the document Engine Compatibility, and the document would live under the Editor section of the manual. I would not mention Editor V2. From the user point of view, there is only one Editor.

In the introduction I would explain that the Editor supports two major release streams of the engine:

  • latest release of engine 1.x.x (engine V1) - this provides support for WebGL1 and WebGL2, but does not receive any new features, and only critical bug fixes.
  • latest release of engine 2.x.x (engine V2) - this has no support for WebGL1 and supports WebGL2 and WebGPU for rendering, and receives new features and fixes.
    I would also mention that you can change which release a project uses.

The following section would be Switching project between Engine V1 and V2 - this corresponds to your Project V1 to V2, but should mentioned V2 to V1 as well.


And then I would suggest a separate document on Editor upgrades, called Editor Migrations. Similarly to how we have this new Engine Migrations (#687) and existing Shader Chunk Migrations. It should introduce the document as describing major changes during Editor releases. And first chapter would be Migration from x.x.x to x.x.y (use actual Editor versions), where we could describe this as Editor internally switching to use Engine V2, and what the impact is for the users. This corresponds to your Editor Changes section.

@kpal81xd kpal81xd changed the title Editor V2 documentation Editor documentation for Engine V2 Jan 16, 2025
@kpal81xd kpal81xd requested a review from willeastcott January 16, 2025 15:09
Copy link
Contributor

@mvaligursky mvaligursky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, leaving suggestion for one clarification.

It'd be fantastic if @willeastcott had a chance to look at this as well.

@kpal81xd kpal81xd requested review from willeastcott and removed request for willeastcott January 17, 2025 14:14
Copy link
Contributor

@willeastcott willeastcott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with some minor tweaks.

docs/user-manual/editor/editor-migrations.md Outdated Show resolved Hide resolved
docs/user-manual/editor/editor-migrations.md Outdated Show resolved Hide resolved
docs/user-manual/editor/editor-migrations.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
docs/user-manual/editor/engine-compatibility.md Outdated Show resolved Hide resolved
@kpal81xd kpal81xd merged commit e8c93a8 into main Jan 20, 2025
2 checks passed
@kpal81xd kpal81xd deleted the editor-v2 branch January 20, 2025 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants