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

Adding video link to BitOps to; README, index, getting-started #386

Merged
merged 8 commits into from
Jan 18, 2023
Merged

Conversation

PhillypHenning
Copy link
Contributor

Description

Updating documentation with BitOps intro video.

Type of change

Please delete options that are not relevant.

  • Documentation update

How Has This Been Tested?

Locally tested with docker-compose

Logs

Screen Shot 2023-01-17 at 2 06 42 PM

Screen Shot 2023-01-17 at 2 06 34 PM

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

@runforesight
Copy link

runforesight bot commented Jan 17, 2023

Foresight Summary

    
Major Impacts
Foresight hasn't detected any major impact on your workflows and tests.

View More Details

✅  CI workflow has finished in 35 seconds and finished at 18th Jan, 2023.


Job Failed Steps Tests
lint-pylint -     🔗  N/A See Details
lint-black -     🔗  N/A See Details

🔎 See details on Foresight

*You can configure Foresight comments in your organization settings page.

README.md Outdated Show resolved Hide resolved
docs/index.md Outdated
Comment on lines 20 to 21
<a class="md-button md-button--primary" href="getting-started">Show me the doc</a>
<a class="md-button md-button--primary" href="https://youtu.be/BiytYu3EefY">Show me a video</a>
Copy link
Member

@arm4b arm4b Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<a class="md-button md-button--primary" href="getting-started">Show me the doc</a>
<a class="md-button md-button--primary" href="https://youtu.be/BiytYu3EefY">Show me a video</a>
<a class="md-button md-button--primary" href="getting-started">Show me the doc</a>

One CTA button is enough.

Instead of "show me the video" button, the idea was to replace the big logo block and adding a video iframe of a similar size. Big BitOps logo is not informational and just takes a precious space.
image

Additionally, bitops logo image might need a rework to make it compact and inline <image> BitOps so we still have it somewhere.

I can work on that, if you think it becomes too involved. Just let me know, can do it after a landing page.

README.md Outdated Show resolved Hide resolved
@PhillypHenning PhillypHenning requested a review from arm4b January 17, 2023 21:09
Copy link
Contributor

@mickmcgrath13 mickmcgrath13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at least change the linked image to pull from youtube

README.md Outdated Show resolved Hide resolved
@@ -1,5 +1,8 @@
# Getting Started

<iframe width="1280" height="500" src="https://www.youtube.com/embed/BiytYu3EefY" title="Intro to BitOps" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason not to put this embed on the front page of bitops.sh?

Copy link
Member

@arm4b arm4b Jan 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge the Readme update here and do the landing page in the next PR: #389 as I'd like more there with the list of bitops values and to align that w video

Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging.
Let's do more on the landing page in the next PR: #389

@arm4b arm4b merged commit caa79a9 into main Jan 18, 2023
@arm4b arm4b deleted the video_doc branch January 18, 2023 22:41
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.

3 participants