elixir-uuid icon indicating copy to clipboard operation
elixir-uuid copied to clipboard

Add a note about the rename in the 1.1 documentation

Open japhib opened this issue 3 years ago • 2 comments

It's unclear to new (or old) users that the library has been renamed to elixir_uuid. If you just google "elixir uuid", this page comes up as the first result:

https://hexdocs.pm/uuid/readme.html

which is the link to 1.1.8 of the library, the release just before the rename. On that page there's no indication of the rename, and no indication that there's any version later than 1.1.8.

Would it be possible to add a note to the readme for that version and make a 1.1.9 release so it shows up in hexdocs?

japhib avatar Jun 15 '21 15:06 japhib

I made a PR for this: #55 - Note the PR is set to merge into master, but ideally instead it'd just remain a separate branch since we wouldn't want this change to affect v1.2+.

Is this even the right approach? If it gets merged & tagged as v1.1.9, will it still update hexdocs for the older repo? I'm new to contributing on Github, so not sure how that all works.

japhib avatar Jun 15 '21 16:06 japhib

Just ran into this exact issue. Having this in the docs would be extremely helpful as I had not realized that the library had been renamed.

hogiyogi597 avatar May 25 '22 16:05 hogiyogi597