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

Conversation

mcmire
Copy link
Collaborator

@mcmire mcmire commented Feb 18, 2024

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.

`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.
Copy link

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

Copy link

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

Copy link

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

Copy link

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

Copy link

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

@mcmire mcmire merged commit 1a5549e into main Feb 19, 2024
27 checks passed
@mcmire mcmire deleted the add-docsite branch February 19, 2024 00:10
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.

1 participant