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

New usage md and breaking changes list #85

Merged
merged 6 commits into from
Nov 2, 2023
Merged

Conversation

marandaneto
Copy link
Member

@marandaneto marandaneto commented Nov 2, 2023

What does this PR do?

#skip-changelog

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots or screencasts (if UI/UX change)

Questions:

  • Does the docs need an update?
  • Are there any security concerns?
  • Do we need to update engineering / success?

@marandaneto marandaneto changed the title Usage iOS SDK New usage md and breaking changes list Nov 2, 2023
@marandaneto marandaneto marked this pull request as ready for review November 2, 2023 11:29
Copy link
Collaborator

@benjackwhite benjackwhite left a comment

Choose a reason for hiding this comment

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

Traditionally we have always pushed people to our docs rather than including instructions in github - trying to avoid duplication.
Given this is pre-release though, makes sense and then we can make a call after release

@marandaneto
Copy link
Member Author

Traditionally we have always pushed people to our docs rather than including instructions in github - trying to avoid duplication. Given this is pre-release though, makes sense and then we can make a call after release

I agree, but right now the docs are structured to only support stable versions unfortunately, no plans to add a dropdown versioning on the docs for now, so better to keep it here till we get to RC and/or stable.
I have a draft PR on the docs replacing the code snippets locally but it'd just cause issues for current customers if merged.

@marandaneto marandaneto merged commit e050cf8 into v3.0.0 Nov 2, 2023
2 checks passed
@marandaneto marandaneto deleted the chore/new-usage branch November 2, 2023 15:25
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