Skip to content

Update README.md#1469

Merged
demiankatz merged 7 commits into
devfrom
mialondon-patch-1
Jul 1, 2025
Merged

Update README.md#1469
demiankatz merged 7 commits into
devfrom
mialondon-patch-1

Conversation

@mialondon

Copy link
Copy Markdown
Contributor

In preparation for presenting the UV to new folk at the Digital Humanities conference in mid-July, some small changes:

  • merged the 'contribute' and 'feedback' sections as they're all part of getting actively involved.
  • added a 'contributors' header.

Merged the 'contribute' and 'feedback' sections as they're all part of getting actively involved. Added a 'contributors' header
@vercel

vercel Bot commented Jun 30, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
universalviewer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 30, 2025 4:20pm

@mialondon mialondon requested a review from LanieOkorodudu June 30, 2025 11:34
More text tweaks designed to help newcomers to the UV understand what it is and how they can get involved

@LanieOkorodudu LanieOkorodudu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@mialondon and @erinburnand, Just a suggestion: In line 60 maybe we could include the word ‘collaborative’ to reflect our ongoing goal of fostering collaboration. ‘A collaborative community of developers, testers, and institutional users has grown around the Universal Viewer.’ Let me know what you both think before I approve. Otherwise, it looks good and well-defined to me if you’re both happy with the way it is. Thanks.

Updated after a suggestion from @LanieOkorodudu
@mialondon

Copy link
Copy Markdown
Contributor Author

@LanieOkorodudu great suggestion, thank you! I've made that tweak and added a little more context for the blog post

@LanieOkorodudu

Copy link
Copy Markdown
Contributor

Thanks so much @mialondon, We just need a final input from @demiankatz to confirm if everything looks good with the update. Always great to have more eyes on it, really appreciate it! Hope you don’t mind me tagging you here, @demiankatz.

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See below for one set of suggestions.

Also, since we're changing some headers around, might we want to consider adding "legacy" anchors for the old headings, in case people have linked directly to these sections from other pages?

Please let me know if you need assistance with technical implementation of anything.

Comment thread README.md Outdated
## 📖 License

The Universal Viewer is released under the [MIT license](https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt).
<a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&button=false" /></a>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For consistency, we should probably use Markdown format rather than HTML to embed this image.

We should be sure to include alt text for consistency.

Maybe to clarify things, the above graphic should be "Institutional Contributors" and this graphic should be "Individual Contributors".

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I didn't want to muck with the page too much, but yes, it'd be good to refresh it all to make it more consistent at some point! In the meantime, Institutional/Individual Contributors is an easy change to make.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I tried Individual contributors but it didn't look great!

@demiankatz demiankatz Jun 30, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How do you feel about [![Individual contributors](https://opencollective.com/universalviewer/contributors.svg?width=890&button=false "Individual contributors")](https://github.com/UniversalViewer/universalviewer/graphs/contributors)?

Individual contributors

...I think the one you didn't like was missing the arguments on the URL, which is why it was so tiny.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note that I just revised the Markdown in the above comment to make the link work correctly too. :-)

Added individual / institutional headers
Added anchors for legacy links
Updated Indiv contribs image thanks to @demiankatz

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @mialondon, I think this is in great shape now!

I'll merge once @LanieOkorodudu approves of the final version.

@LanieOkorodudu LanieOkorodudu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

And thanks @mialondon you for updating the README. It’s all set to merge @demiankatz. I appreciate everyone's effort and time. Thanks everyone! :-)

@demiankatz demiankatz merged commit 3ee2eec into dev Jul 1, 2025
6 checks passed
@demiankatz demiankatz deleted the mialondon-patch-1 branch July 1, 2025 10:24
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.

3 participants