Prepare documentatnion before the release of `render-html`

[5ZYSZ3K]

Description

Before the incoming release of render-html package, we should adjust the documentation of this repository, as it will now be used directly by users

Things to do:

• Adjust README.md
• Add contributing guides
• Add issue template

I think that most of them can revised and copied over from react-native-render-html.

Additional work:

• Host docs website

[5ZYSZ3K]

@jsamr please tell me what are your thoughts on this

[jsamr]

@5ZYSZ3K I want to express my gratitude once again for the critical work you and your team did. Reviving / migrating this project was not a simple task.

I wonder if you've managed to preserve the tooling that was in place to generate changelogs automatically from commits? I had managed to have it scoped to different packages, using commit conventions. That'd be awesome!

The docs website transition can come later on, it's less critical.

Finally, I'm not sure if you'll have the credentials in NPM to release. Let me know if you're blocked.
Ideally, at some point, we'd set up an automatic rollout flow.

[5ZYSZ3K]

@5ZYSZ3K I want to express my gratitude once again for the critical work you and your team did. Reviving / migrating this project was not a simple task.

I wonder if you've managed to preserve the tooling that was in place to generate changelogs automatically from commits? I had managed to have it scoped to different packages, using commit conventions. That'd be awesome!

No, we haven't yet, but I'll add that to the list of things to complete

The docs website transition can come later on, it's less critical.

That's right, but anyway, I would like to have a readme here, to let people know, what happened here. I guess I'll prepare a PR with files copied over from the previous repository and adjusted to our needs

Finally, I'm not sure if you'll have the credentials in NPM to release. Let me know if you're blocked. Ideally, at some point, we'd set up an automatic rollout flow.

About this: do you have the access to publish under the name of react-native-render-html, or do you want to release it as @native-html/render-html?
We were discussing that internally, and we think that it would be worth a shot to try to contact npm and to reclaim the old name, if you don't have the access to release there. What do you think about that?

[jsamr]

About this: do you have the access to publish under the name of react-native-render-html, or do you want to release it as @native-html/render-html?

I still have maintainer access to NPM react-native-render-html. I'm a bit torn between the two options. I understand the convenience argument for end-users, but at the same time it feels like a new chapter, hosted in a different place, with issue tracking in a new repo. And a move to @native-html/render-html conveys that change very well. I should be able to deprecate react-native-render-html in NPM and inform users they should use @native-html/render-html instead. Also update the old repo accordingly, and then try archiving it.

I was also considering renaming the core repository to render-html to keep consistency. What do you guys think?

[mironiasty]

I can see benefits of both options (keeping old name and moving to new one). But I would vote for deprecating react-native-render-html and starting new chapter with new name.

I was also considering renaming the core repository to render-html to keep consistency. What do you guys think?

+1 to having same repo name as package.

[5ZYSZ3K]

Personally I thought that preserving the old name would be better, but I see your arguments, and it's not like it's a strong preference from my side, so I guess we can proceed with the new name.
@jsamr what would you say about naming the package @native-html/render instead of @native-html/render-html? For me, that repetition sticks out a bit too much

[jsamr]

I'm cool with @native-html/render

Let's rename the package and the repo, then!