search

splitwise / super_diff

A more helpful way to view differences between complex data structures in RSpec.
https://splitwise.github.io/super_diff/
MIT License
991 stars 54 forks source link

Add docsite #225

Closed mcmire closed 9 months ago

mcmire commented 9 months ago

docs/ now holds Markdown files that will be published to a docsite generated by mkdocs and hosted on GitHub Pages. Using mkdocs allows us to try out literate programming. This requires Python, so that's been added to the setup script.

Thanks to some new GitHub actions, provided there have been any changes to the docs, a preview version of the docsite will be automatically published when a pull request is updated (in which case the URL will be https://mcmire.github.io/super_diff/branches/<branch-name>/<commit.id>), and a release version will be published when a release PR is merged (in which case it will be https://mcmire.github.io/super_diff/releases/<version>). Any preview version that have been previously been created for a pull request will be deleted when that pull request is closed.

The CONTRIBUTING and ARCHITECTURE docs have been moved into docs/ and expanded to not only explain how SuperDiff works but also the RSpec integration.

github-actions[bot] commented 9 months ago

:book: A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/45fbf3ea290ace897da059d6f7b27fefd3f60167

github-actions[bot] commented 9 months ago

:book: A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/f799d89172c1b0a3626216d2267ac5cee517e015

github-actions[bot] commented 9 months ago

:book: A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/bdbe233d9fe4739c33fcabe697d6a0c008b0a358

github-actions[bot] commented 9 months ago

:book: A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/add-docsite

github-actions[bot] commented 9 months ago

:book: A new version of the docsite has been published at: https://mcmire.github.io/super_diff/branches/add-docsite/f99e890292b78a35bb5e2491e5577e187005d0a3