Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docsite #225

Merged
merged 5 commits into from
Feb 19, 2024
Merged

Add docsite #225

merged 5 commits into from
Feb 19, 2024

Commits on Feb 18, 2024

  1. Add docsite

    `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.
    mcmire committed Feb 18, 2024
    Configuration menu
    Copy the full SHA
    6407eab View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    061821d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1b33ebf View commit details
    Browse the repository at this point in the history

Commits on Feb 19, 2024

  1. Configuration menu
    Copy the full SHA
    bb94fe5 View commit details
    Browse the repository at this point in the history
  2. Oops, use the SHA

    mcmire committed Feb 19, 2024
    Configuration menu
    Copy the full SHA
    f99e890 View commit details
    Browse the repository at this point in the history