samvera / hyku

Hyku: A multi-tenant Hyrax application built on the latest and greatest Samvera community components. Brought to you by the Hydra-in-a-Box project partners and IMLS; maintained by the Hyku Interest Group.
https://samvera.atlassian.net/wiki/spaces/hyku/overview
Other
94 stars 46 forks source link

:gift: documentation reorg per ryan-lang #2232

Closed ShanaLMoore closed 1 month ago

ShanaLMoore commented 1 month ago

Contribution by @ryan-lang. I created this PR due to issues with a failing build in the original PR.

ref original PR:

Per @ryan-lang

Fixes #1920 Fixes #1981 Fixes #2155 Fixes #2142

Simply reorganizes the existing README documentation for clarity purposes, which had grown to a point where it was getting difficult to follow. Also adds a canonical approach to running the latest "stable" version locally, as suggested by @jeremyf here.

I'm a complete novice with the Samvera stack, so the documentation is mostly copy-paste from the original README, but I felt this would be a good step towards fixing a persistent pain point for new users, and good scaffolding for future doc improvements.