Skip to content

chore: update develop-2.0.0 with v2.11.2 changelog and door example#3966

Merged
NoelStephensUnity merged 3 commits intodevelop-2.0.0from
chore/update-develop-2-11-2-changelog-and-doorexample
May 4, 2026
Merged

chore: update develop-2.0.0 with v2.11.2 changelog and door example#3966
NoelStephensUnity merged 3 commits intodevelop-2.0.0from
chore/update-develop-2-11-2-changelog-and-doorexample

Conversation

@NoelStephensUnity
Copy link
Copy Markdown
Member

Purpose of this PR

  • This PR updates the develop-2.0.0. branch with the v2.11.2 changelog entry.
  • This PR includes the updated NetworkVariable door example update for documentation.
    • This is outside of the package. Starting to put documentation related source files in the parent of this file's target directory.

Jira ticket

NA

Changelog

NA

Documentation

  • No documentation changes or additions were necessary.

Testing & QA (How your changes can be verified during release Playtest)

Functional Testing

Manual testing :

  • Manual testing done

Automated tests:

  • Covered by existing automated tests
  • Covered by new automated tests

Does the change require QA team to:

  • Review automated tests?
  • Execute manual tests?
  • Provide feedback about the PR?

If any boxes above are checked the QA team will be automatically added as a PR reviewer.

Backports

No back port required.

Updating changelog entry.
Adding new NetworkVariable door example used for documentation.
@NoelStephensUnity NoelStephensUnity marked this pull request as ready for review May 2, 2026 17:26
@NoelStephensUnity NoelStephensUnity requested a review from a team as a code owner May 2, 2026 17:26
@NoelStephensUnity NoelStephensUnity changed the title chore: update develop 2.11.2 changelog and door example chore: update develop-2.0.0 with v2.11.2 changelog and door example May 2, 2026
@michalChrobot michalChrobot requested review from a team and EmandM as code owners May 3, 2026 14:00
/// This is a simple state driven door example.
/// This script was written with recommended usages patterns in mind.
/// </remarks>
public class Door : NetworkBehaviour, INetworkUpdateSystem
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does "DocumentationExamples" means actual documentation in that sense (so we would ping Amy to double check) or functions more as code pattern for users (so maybe we could change the name to something more like "CodePatterns" or remove this subfolder compleately and have it under Examples/NetworkVariable/DoorExample"

Copy link
Copy Markdown
Member Author

@NoelStephensUnity NoelStephensUnity May 4, 2026

Choose a reason for hiding this comment

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

It is a place to keep working versions of our documentation examples for two reasons:

  • If you want to test an example (currently), you have to copy it, paste it into a file, setup a test specific to the example, and then verify the example works.
    • The initial thought was to use this for our testing and modification purposes.
  • We could eventually move these into samples, which then we can include:
    • The script (or a section of the script) and then always (under the source) link to the sample or script.

Many of our examples are "too simplified" such that it can leave room for users to make assumptions which may or may not be correct... if we are very clear about the "usage pattern" then hopefully that will help provide users with a pattern that won't lead to issues down the road.

Copy link
Copy Markdown
Member

@michalChrobot michalChrobot May 4, 2026

Choose a reason for hiding this comment

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

Hmm, during Unity Talks there was a talk from Oleksandr Kokoshyn about Making code examples in Unity docs testable which I guess is what we are trying to achieve here? (Talk is not yet available but I think will be this week)

[DOCS link]
[See N4E reference]

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah... trying to start preparing NGO to follow a similar pattern now so it makes it easier down the road.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What about merging this as it is for now and create task to update those in the same way

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I could have used #3959 to add the door example script... next time I will make sure to do that.

@NoelStephensUnity NoelStephensUnity merged commit 916b47b into develop-2.0.0 May 4, 2026
23 checks passed
@NoelStephensUnity NoelStephensUnity deleted the chore/update-develop-2-11-2-changelog-and-doorexample branch May 4, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants