Skip to content

Conversation

@Sushma-1706
Copy link

Description

What is this PR
Other (documentation improvement)

Why is this PR needed?
The documentation landing page currently contains only static images.
Adding a lightweight demo GIF gives new users a quick visual overview of how
datashuttle works, helping them understand the tool without reading through
multiple pages.

This was suggested in issue #577.

What does this PR do?
This PR adds a demo GIF to the documentation homepage using Sphinx’s
{image} directive.
The GIF is stored in the _static directory and displayed prominently on the
landing page without replacing the existing light and dark images.

References
Closes #577

How has this PR been tested?
This change is documentation-only.
The documentation was built locally to confirm that the GIF renders correctly
and does not affect layout or styling.

Is this a breaking change?
No. This PR does not change any runtime behavior or APIs.

Does this PR require an update to the documentation?
Yes. This PR updates the documentation homepage by adding a demo GIF.

Checklist
Documentation has been updated to reflect the change
No code or behavior changes were introduced

@JoeZiminski
Copy link
Member

JoeZiminski commented Jan 2, 2026

Hi @Sushma-1706 thanks for this, I see this PR includes the commit related to the developer documentation. This is a common problem with git, when you make a new branch if you do not branch off main but instead branch off a PR branch, you will include those commits. Because you are on a fork make sure to sync for your fork main with the datashuttle main using the button on the GitHub interface

The easiest way to deal with this is to git rebase onto main and drop the extra commits. You can follow this guide. The main workflow will be to

git commit main
git pull
git checkout docs-add-gif
git rebase -i main

and then follow that guide to drop the old commit

@Sushma-1706
Copy link
Author

Sushma-1706 commented Jan 2, 2026 via email

@Sushma-1706
Copy link
Author

Thanks for the review and guidance @JoeZiminski 🙏
I’ve rebased the branch onto main, dropped the unrelated commit, and force-pushed the cleaned history.
All checks are now passing. Please let me know if you’d like any further changes.

@JoeZiminski
Copy link
Member

Brilliant, thanks @Sushma-1706! I've approved the workflow runs, you will see on the 'Checks' tab there is an 'artifact.ci' section. This contains a preview of the docs on any PR. I'll test this on a new PCs / networks to double check and get back to you, but in general this looks great. thanks!

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.

Extend ssh, aws and gdrive tests

2 participants