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

Chore: (Docs) updates testing examples #19757

Closed
wants to merge 6 commits into from

Conversation

jonniebigodes
Copy link
Contributor

With this pull request, the documentation is updated to address and close both #19572 and #19703.

What was done:

  • Updated the documentation/snippets for supported frameworks for the usage of canvasElement throughout docs.
  • Updated the links to point to the right documentation place.
  • Removed the step function temporarily from the documentation as based on testing with the latest stable version, it's not working.
  • Updated the documentation for usage of Vue TS throughout the docs as it's already documented.

A follow-up pull request porting the changes over to CSF 3 will be up after this is merged.
@shilman I've assigned this directly to you so that you could take a pass at this and pick it to allow it to be available to the current docs.

Let me know of any feedback. Thanks in advance.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Nov 4, 2022
@jonniebigodes jonniebigodes changed the title Chore docs updates testing examples Chore: (Docs) updates testing examples Nov 4, 2022
Copy link
Member

shilman commented Nov 7, 2022

@jonniebigodes Let's discuss this one. It looks like you're updating 7.0 examples back to 6.5 Template style? Is that because we're going to redo all of this in 7.0 anyway?

Would it be more appropriate to do a PR directly against main in this case?

@jonniebigodes
Copy link
Contributor Author

jonniebigodes commented Nov 7, 2022

@shilman yes, I'm already in the process of updating the examples per #19665 to align them to the same structure used there.

Copy link
Member

shilman commented Nov 7, 2022

@jonniebigodes so it's ok to merge this into next even if it reverts the examples back to 6.5 style?

@jonniebigodes
Copy link
Contributor Author

We can merge now and pick it to be released, and I'll continue working on the examples, and once the pr is up, I'll leave the documentation label.

Copy link
Member

shilman commented Nov 7, 2022

@jonniebigodes OK, i'm just worried there will be tons of merge conflicts when we bring it back to 6.5. It touches a ton of files.

@jonniebigodes
Copy link
Contributor Author

@shilman if that's the case, feel free to close this one, and I'll create a branch of the main and base it on that and adjust accordingly and submit the pull request aimed at main. Sounds good?

Copy link
Member

shilman commented Nov 7, 2022

Yes, or perhaps you can just try targeting this one into main and resolving the conflicts there if it's easier

@jonniebigodes
Copy link
Contributor Author

I have already a backup of this so no worries there.

Copy link
Member

shilman commented Nov 7, 2022

Ok, your call! Thanks & looking forward to the new PR 🙏

@jonniebigodes jonniebigodes deleted the chore_docs_updates_testing_examples branch November 7, 2022 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants