Skip to content

Conversation

@pelin-d
Copy link

@pelin-d pelin-d commented Nov 1, 2024

User description

Description of Changes

To unify the documentation, the information on Github is moved to the developers docs

Breaking Changes

  • None

Release Checklist

Prepare:

  • Detail any breaking changes. Breaking changes require a new major version number, and a migration guide in wiki / README.md
  • After update android proxy classes, rebuild OptimoveUnityPlugin.aar
  • Make sure changes are present in both ExampleApp and unity-sdk projects
  • When exporting .unitypackage from unity-sdk don't include dependencies, don't export scene

Bump versions in:

  • OptimoveSDKPlugin.swift
  • OptimoveInitProvider.java
  • Optimove-x.x.x.unitypackage should have a name matching release version

Release Procedure

  • Squash and merge dev to master
  • Create a tag matching release version
  • Delete branch once merged

Generated description

Below is a concise technical summary of the changes proposed in this PR:
Relocates the detailed integration and setup documentation for the Optimove Unity SDK from the README.md file to the official developer documentation portal. Directs users to external links within README.md for comprehensive guides on getting started and SDK reference.

Latest Contributors(2)
UserCommitDate
kris_e@optimove.comUpdate-README.mdMarch 19, 2025
eligutovskydocs-add-note-15September 26, 2023
This pull request is reviewed by Baz. Review like a pro on (Baz).

@pelin-d pelin-d changed the title Removed integration from readme, added link instead 201841: The documentation is moved tio dev docs Nov 1, 2024
@pelin-d pelin-d changed the title 201841: The documentation is moved tio dev docs 201841: The documentation is moved to dev docs Nov 1, 2024
@pelin-d pelin-d marked this pull request as ready for review November 1, 2024 15:18
@pr-work-item-validator
Copy link

👋 Hey @pelin-d,

❗️ Work Item link check failed: There is no Work Item linked to this PR.

🧩 Please add the Work Item ID to the PR title or description using the "Edit" option in the format below:
AB#XXXXX - replace X with a valid Work Item ID.

🟢 Once added, the validation will automatically run again!

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