Qiskit / Qiskit/documentation

Add cross-reference from SQD IEF-PCM function template guide to the implicit solvent tutorial

Open Beginner friendly
#5,397 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/guides/function-template-chemistry-workflow -- "Next steps" section

Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

The implicit solvent calculations tutorial (https://quantum.cloud.ibm.com/docs/en/tutorials/implicit-solvent-calculations) links to the SQD IEF-PCM function template guide in several places: the Background section, a mid-page note, and Next steps. However, the function template guide does not link back to the tutorial: its Next steps section only references the Hamiltonian simulation template guide and the GitHub source files.

Suggested fix: add a link to the implicit solvent tutorial in the template guide's Next steps section (and/or its introduction), so users of the streamlined template can discover the in-depth workflow it is based on. This would make the cross-referencing between this tutorial/template pair bidirectional.

Value: users who land on the function template first currently have no path to the full pedagogical walkthrough, even though the tutorial explicitly positions the template as its streamlined counterpart.

For new content requests - if the request is accepted, do you want to write the content?

(No answer)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the function template chemistry workflow guide and its Next steps section, then compare it with the implicit solvent calculations tutorial. Add a link from the template guide to the tutorial so the two resources cross-reference each other, and verify the rendered documentation link works.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.