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

Improve Landing Page and Quickstart Guide #292

Merged
merged 5 commits into from
Aug 22, 2023
Merged

Conversation

callumforrester
Copy link
Collaborator

Addresses some of the concerns raised in #279

Changes:

  • Add concept explanation and diagram to documentation landing page
  • Add brief description and testing instructions to quickstart guide

@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

Merging #292 (d6229cc) into main (1dd6b0f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #292   +/-   ##
=======================================
  Coverage   89.44%   89.44%           
=======================================
  Files          41       41           
  Lines        1412     1412           
=======================================
  Hits         1263     1263           
  Misses        149      149           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@callumforrester
Copy link
Collaborator Author

Copy link
Contributor

@DominicOram DominicOram left a comment

Choose a reason for hiding this comment

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

Great, work, thanks. Not strictly part of this PR I guess but the CLI commands on Quickstart->Start Worker do not work for my latest install of blueapi

README.rst Outdated Show resolved Hide resolved
@callumforrester
Copy link
Collaborator Author

@DominicOram The CLI commands work for me, could you confirm which version of blueapi you are using?
These commands should work for >=0.3.0

Copy link
Contributor

@DominicOram DominicOram left a comment

Choose a reason for hiding this comment

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

My bad, all good with latest blueapi version

@callumforrester callumforrester marked this pull request as ready for review August 22, 2023 08:17
@callumforrester callumforrester merged commit 645767c into main Aug 22, 2023
23 checks passed
@callumforrester callumforrester deleted the welcome-page branch August 22, 2023 08:17
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.

2 participants