Skip to content

TINYINT-3455: Update details - #79

Open
tiny-ben-tran wants to merge 3 commits into
mainfrom
feature/TINYINT-3455
Open

tiny-ben-tran wants to merge 3 commits into
mainfrom
feature/TINYINT-3455

Conversation

@tiny-ben-tran

Copy link
Copy Markdown
Contributor

Related tickets: TINYINT-3455

Description of changes:

  • Updated readme and contributing md files.
  • Updated description and keywords in package.json to improve discoverability

@tiny-ben-tran
tiny-ben-tran marked this pull request as ready for review September 25, 2026 02:38
@tiny-ben-tran
tiny-ben-tran requested a review from a team as a code owner September 25, 2026 02:38
@tiny-ben-tran
tiny-ben-tran requested review from a team, MitchC1999, TheSpyder, hamza0867, shanmen-tiny, soritaheng and spocke and removed request for a team September 25, 2026 02:38
Comment thread contributing.md

External contributors are free to submit PRs against the `main` branch.
Note that contributions will require signing of our Contributor License Agreement.
In order for Tiny to accept your contribution, we will need legal permission from you to use your code. Please email `legal@tiny.cloud` with the subject `CLA request for [your Github username]`. Our legal team will send you a Contributors License Agreement (CLA) which you will need to sign and return.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

this is missing a line compared to the usual template, right? 'welcome to make prs' or someting

Comment thread README.md
## About

Web Components are a set of built-in browser capabilities that let developers create custom HTML elements in a similar manner to what is available in frameworks like React or Angular.
Official Web Component for TinyMCE, the rich text editor. It wraps TinyMCE as a `<tinymce-editor>` custom element, used in place of calling `tinymce.init()`. By default, it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I am wondering if we should add another sentence or two from the old content that explains what exactly this is/how to use it? I don't know web components well, or how much most devs would know about them / what they might be looking for that would lead them to this integration though tbh.

Comment thread README.md

### Self hosted via NPM package

Using TinyMCE from NPM with the Web Component requires a couple of extra steps. See the documentation for more information: [Using TinyMCE with Web Components - Self hosted via NPM](https://www.tiny.cloud/docs/tinymce/latest/webcomponent-pm/)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
Using TinyMCE from NPM with the Web Component requires a couple of extra steps. See the documentation for more information: [Using TinyMCE with Web Components - Self hosted via NPM](https://www.tiny.cloud/docs/tinymce/latest/webcomponent-pm/)
Using TinyMCE from NPM with the Web Component integration requires a couple of extra steps. See the documentation for more information: [Using TinyMCE with Web Components - Self hosted via NPM](https://www.tiny.cloud/docs/tinymce/latest/webcomponent-pm/)

i think this needs another word. up further too...

Comment thread README.md
@@ -1,19 +1,51 @@
# Official Web Component for TinyMCE

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
# Official Web Component for TinyMCE
# Official Web Component integration for TinyMCE

needs another word, otherwise it sounds like we're using 'component' the way we do for the react integration, etc.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

commented on a couple like this but i may have missed instances - please check

Comment thread README.md
## About

Web Components are a set of built-in browser capabilities that let developers create custom HTML elements in a similar manner to what is available in frameworks like React or Angular.
Official Web Component for TinyMCE, the rich text editor. It wraps TinyMCE as a `<tinymce-editor>` custom element, used in place of calling `tinymce.init()`. By default, it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
Official Web Component for TinyMCE, the rich text editor. It wraps TinyMCE as a `<tinymce-editor>` custom element, used in place of calling `tinymce.init()`. By default, it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce).
Official Web Components integration for TinyMCE, the rich text editor. It wraps TinyMCE as a `<tinymce-editor>` custom element, used in place of calling `tinymce.init()`. By default, it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce).

also wondering if there should be an s on Component now...

Comment thread package.json
@@ -1,2 +1,2 @@
{
"description": "Official TinyMCE Web Component",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
"description": "Official Web Component integration for TinyMCE rich text editor",

to match the others?

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