Update README positioning for researchers #6411

justinpickering · 2024-10-17T19:39:48Z

Context:
See EPIC: [P1] Update PennyLane GitHub repo README content positioning for researchers

github-actions · 2024-10-17T19:40:03Z

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.

Updated to match https://pennylane.ai/features/ page listed features. These features will also be listed on the upcoming research page.

justinpickering · 2024-10-18T15:01:46Z

Hey @josh146 @ixfoduap @Lorraine-at-Xanadu - I've added you as reviewers to this PR for updating the PennyLane README. The PR description includes a link to the EPIC that provides context.

To get the ball rolling, I've made the current changes (so far):

Overview section:
- Updated messaging: The definitive open-source Python framework for quantum programming. Built by researchers, for research..
- Removed Train a quantum computer the same way as a neural network. copy.
Key Features section:
- Updated to reflect the features highlighted in the pennylane.ai /features page. Note, the new 'Research' page will also include these features, so we should be consistent here as well.
- Added link to our /features page.
Getting started section:
- Updated copy.
- Added "Key resources" section with links to the new Codebook and Coding Challenges
- Replaced "what is QML" link, with more general "Learn quantum programming" link.
Demos section:
- Renamed from Tutorials and demonstrations to Demos
- revised and removed some copy
Removed the Videos section entirely (videos are already referenced in the Getting started section)
Added a Research Applications section:
- Includes placeholder links for papers.
- Thoughts? Purely an idea inspired by designs of the new research page (which will include a section with links to papers).

Please let me know if any feedback on changes proposed above, or anywhere on the README page in light of our goal to improve positioning for researchers. Also, I'd appreciate your thoughts on:

Badges section: are there any other important badges that we can display?
Images: the majority are outdated (overview, key features, Getting started, Demos). I will discuss with Tarik if there are any improvements we can make here.

codecov · 2024-10-18T15:55:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.34%. Comparing base (ee294b6) to head (4c00410).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6411   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files         456      456           
  Lines       43258    43258           
=======================================
  Hits        42973    42973           
  Misses        285      285

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

josh146

Nice work @justinpickering! Already a big improvement

README.md

Co-authored-by: Josh Izaac <josh146@gmail.com>

Lorraine-at-Xanadu · 2024-10-18T23:03:55Z

Hey @justinpickering!

I recommend revising the sentence related to the PennyLane Discussion Forum to the following:

Join the PennyLane Discussion Forum to connect with the quantum community, get support, and engage directly with our team. It’s the perfect place to share ideas, ask questions, and collaborate with fellow researchers and developers!

The Code of Conduct on GitHub is different from the Code of Conduct on PennyLane.ai. Should they be the same? If not, is the one on GitHub up-to-date?

Lorraine-at-Xanadu · 2024-10-18T23:17:13Z

Hi @justinpickering!

I recommend changing 'developer hub' to 'Development guide' for consistency with the head on the webpage.
The page linking from 'contributions page' looks like it may be a bit out of date. For example, the first few lines still have a QML focus. Do we respond to users in the PennyLane Discussion Forum within "a couple of hours"? There are opportunities to change the messaging so it speaks to researchers.

Lorraine-at-Xanadu · 2024-10-18T23:17:45Z

Overall, this looks really good, @justinpickering. Thank you very much for taking this on. 🙏

justinpickering · 2024-10-21T18:26:58Z

Thank you for the feedback, @Lorraine-at-Xanadu!

I recommend revising the sentence related to the PennyLane Discussion Forum to the following:

Join the PennyLane Discussion Forum to connect with the quantum community, get support, and engage directly with our team. It’s the perfect place to share ideas, ask questions, and collaborate with fellow researchers and developers!

This has been updated (98673ef) ✅

The Code of Conduct on GitHub is different from the Code of Conduct on PennyLane.ai. Should they be the same? If not, is the one on GitHub up-to-date?

I am not entirely sure here, as this is a contributor code of conduct whose purpose may be different.
@josh146 - would we need to update our CoC link to include the Code of Conduct on PennyLane.ai. Is the contributor CoC still valid?

I recommend changing 'developer hub' to 'Development guide' for consistency with the head on the webpage.

This has been updated. (4b6f93c) ✅

The page linking from 'contributions page' looks like it may be a bit out of date. For example, the first few lines still have a QML focus. Do we respond to users in the PennyLane Discussion Forum within "a couple of hours"? There are opportunities to change the messaging so it speaks to researchers.

This page mimics the contributions page in our documentation though it looks like it hasn't been updated since 2022 (based on commit history). Happy to suggest updates to this page as well!

josh146 · 2024-10-22T07:24:22Z

This page mimics the contributions page in our documentation though it looks like it hasn't been updated since 2022 (based on commit history). Happy to suggest updates to this page as well!

Good idea to update this page! Let's do it as a separate epic/task.

I am not entirely sure here, as this is a contributor code of conduct whose purpose may be different.
@josh146 - would we need to update our CoC link to include the Code of Conduct on PennyLane.ai. Is the contributor CoC still valid?

Good point -- the one on GitHub is more for development discussion and contributions, and the one on the website seems more geared towards events.

for now let's leave them as is, but make a note to revisit this to understand if they should be merged. We can also have a link on the Github CoC pointing to the website one.

justinpickering · 2024-10-23T13:54:30Z

Good idea to update this page! Let's do it as a separate epic/task.

Sounds good 👍

for now let's leave them as is, but make a note to revisit this to understand if they should be merged. We can also have a link on the Github CoC pointing to the website one.

I'll create a backlog ticket to revisit this.

justinpickering · 2024-10-28T18:51:23Z

[sc-76991]

Lorraine-at-Xanadu

Thanks, @justinpickering.

README.md

**Context:** See EPIC: [[P1] Update PennyLane GitHub repo README content positioning for researchers](https://app.shortcut.com/xanaduai/epic/76283/p1-update-content-in-pennylane-github-repository-readme?cf_workflow=500000005&ct_workflow=all&group_by=none) --------- Co-authored-by: Josh Izaac <josh146@gmail.com> Co-authored-by: ixfoduap <40441298+ixfoduap@users.noreply.github.com>

Update README.md

fbaa4bd

justinpickering added 7 commits October 17, 2024 16:18

Update keyfeatures

d115949

Updated to match https://pennylane.ai/features/ page listed features. These features will also be listed on the upcoming research page.

Update README.md

dbe9ec7

update key features copy

938c569

Update Demos section

88eae76

add research applications section, remove videos

8cdd1c6

update research applications section

ce79c92

update Getting started section

439ff4a

justinpickering requested review from josh146, ixfoduap and Lorraine-at-Xanadu October 18, 2024 15:02

justinpickering marked this pull request as ready for review October 18, 2024 15:27

josh146 reviewed Oct 18, 2024

View reviewed changes

justinpickering and others added 5 commits October 18, 2024 17:39

Update README.md

60ed710

Co-authored-by: Josh Izaac <josh146@gmail.com>

add devices page link

b999c3a

Update README.md

72ff2a9

Co-authored-by: Josh Izaac <josh146@gmail.com>

Update README.md

5184377

Co-authored-by: Josh Izaac <josh146@gmail.com>

revert back to previous Compilation key features description

989302d

justinpickering added 2 commits October 21, 2024 14:01

update discussion forum copy

98673ef

update copy (developer hub -> Development guide)

4b6f93c

justinpickering added 10 commits November 6, 2024 09:31

Add files via upload

53d29a1

update image link for preview

22c0117

Add files via upload

6e75929

Add files via upload

ab6eacf

Update README.md

77bfe29

Add files via upload

fda5eef

update 'getting started' image

b71cc2f

update getting started image width

8d5a964

point image preview back to master

f1e9873

Merge branch 'master' into readme-update

fc14b20

justinpickering enabled auto-merge (squash) November 6, 2024 22:01

Lorraine-at-Xanadu approved these changes Nov 7, 2024

View reviewed changes

justinpickering disabled auto-merge November 7, 2024 15:45

justinpickering added 10 commits November 7, 2024 10:45

Merge branch 'master' into readme-update

d06334a

Update README.md

0118a18

Update README.md

8eae8ba

Add files via upload

4617682

Update README.md

7a424cf

Update README.md

e309c16

Update README.md

b9dd095

revert PL image

43f3a2d

Add files via upload

31ee87a

Merge branch 'master' into readme-update

7e433d2

justinpickering added the merge-ready ✔️ All tests pass and the PR is ready to be merged. label Nov 8, 2024

justinpickering enabled auto-merge (squash) November 8, 2024 20:02

albi3ro added the urgent Mark a pull request as high priority label Nov 8, 2024

Merge branch 'master' into readme-update

4c00410

justinpickering merged commit 7153fe7 into master Nov 8, 2024
45 checks passed

justinpickering deleted the readme-update branch November 8, 2024 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README positioning for researchers #6411

Update README positioning for researchers #6411

justinpickering commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024

justinpickering commented Oct 18, 2024 •

edited

Loading

codecov bot commented Oct 18, 2024 •

edited

Loading

josh146 left a comment

Lorraine-at-Xanadu commented Oct 18, 2024

Lorraine-at-Xanadu commented Oct 18, 2024

Lorraine-at-Xanadu commented Oct 18, 2024

justinpickering commented Oct 21, 2024

josh146 commented Oct 22, 2024

justinpickering commented Oct 23, 2024

justinpickering commented Oct 28, 2024

Lorraine-at-Xanadu left a comment

Update README positioning for researchers #6411

Update README positioning for researchers #6411

Conversation

justinpickering commented Oct 17, 2024 • edited Loading

github-actions bot commented Oct 17, 2024

justinpickering commented Oct 18, 2024 • edited Loading

codecov bot commented Oct 18, 2024 • edited Loading

Codecov Report

josh146 left a comment

Choose a reason for hiding this comment

Lorraine-at-Xanadu commented Oct 18, 2024

Lorraine-at-Xanadu commented Oct 18, 2024

Lorraine-at-Xanadu commented Oct 18, 2024

justinpickering commented Oct 21, 2024

josh146 commented Oct 22, 2024

justinpickering commented Oct 23, 2024

justinpickering commented Oct 28, 2024

Lorraine-at-Xanadu left a comment

Choose a reason for hiding this comment

justinpickering commented Oct 17, 2024 •

edited

Loading

justinpickering commented Oct 18, 2024 •

edited

Loading

codecov bot commented Oct 18, 2024 •

edited

Loading