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 documentation on device docs #6325

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Adding documentation on device docs #6325

wants to merge 22 commits into from

Conversation

albi3ro
Copy link
Contributor

@albi3ro albi3ro commented Oct 2, 2024

Context:

Replacing stale #5783 [sc-53730]

Description of the Change:

Benefits:

Possible Drawbacks:

Related GitHub Issues:

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.39%. Comparing base (0f76651) to head (3c3746d).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6325   +/-   ##
=======================================
  Coverage   99.39%   99.39%           
=======================================
  Files         448      448           
  Lines       42472    42474    +2     
=======================================
+ Hits        42217    42219    +2     
  Misses        255      255           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@albi3ro albi3ro requested a review from astralcai October 2, 2024 22:03
Copy link
Contributor

@astralcai astralcai left a comment

Choose a reason for hiding this comment

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

I feel that in many cases, this guide is explaining different aspects of the execution workflow without putting it in the context of how a plugin can be implemented. Many examples describes how a device should behave and how it is used in the workflow but there isn't a corresponding example to explain what a plugin developer needs to do to make it work like expected.

doc/development/plugins.rst Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Show resolved Hide resolved
doc/development/plugins.rst Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Show resolved Hide resolved
doc/development/plugins.rst Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
albi3ro and others added 2 commits October 8, 2024 17:07
Co-authored-by: Astral Cai <astral.cai@xanadu.ai>
Copy link
Contributor

@astralcai astralcai left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you for doing this! 🎸

Copy link
Contributor

@JerryChen97 JerryChen97 left a comment

Choose a reason for hiding this comment

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

lgtm!!!

Copy link
Contributor

@isaacdevlugt isaacdevlugt left a comment

Choose a reason for hiding this comment

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

Thanks Christina! Looks good to me, just found some grammar suggestions.

doc/development/legacy_plugins.rst Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
albi3ro and others added 4 commits October 11, 2024 11:27
Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>
Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>
Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com>
Copy link
Contributor

@astralcai astralcai left a comment

Choose a reason for hiding this comment

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

Not sure if these are related to the failing doc builds.

doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/legacy_plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
doc/development/plugins.rst Outdated Show resolved Hide resolved
Co-authored-by: Astral Cai <astral.cai@xanadu.ai>
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.

4 participants