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

Add links from non-API pages to GitHub for API source code #613

Closed
beckykd opened this issue Jan 10, 2024 · 7 comments
Closed

Add links from non-API pages to GitHub for API source code #613

beckykd opened this issue Jan 10, 2024 · 7 comments
Assignees

Comments

@beckykd
Copy link
Collaborator

beckykd commented Jan 10, 2024

The source code is hard to find. There are plans to link to source code as appropriate from topics with example code (#454 ), but we should also just help people find it.

@beckykd beckykd added this to the 24-02-13 Qiskit 1.0 milestone Jan 10, 2024
@beckykd beckykd self-assigned this Jan 10, 2024
@Eric-Arellano
Copy link
Collaborator

but we should also just help people find it.

What does this mean?

@beckykd
Copy link
Collaborator Author

beckykd commented Jan 10, 2024

but we should also just help people find it.

What does this mean?

I mean, it's really hard to find the actual source code right now. If you go to qiskit.org, there's just the home page and as far as I know, the only way to get to the source code from that page is the "pill" in the upper left corner, which I just now found :) So I think it would be nice to have links from the docs to the source code.

@Eric-Arellano
Copy link
Collaborator

Sure, but I'm not understanding what this means once we have #454 in place. Are you suggesting the non-API docs link more frequently to GitHub? Or we add GitHub to the top or left navigation?

@beckykd
Copy link
Collaborator Author

beckykd commented Jan 10, 2024

In response to @javabster 's comment (question - is the plan for this source code link to just be available for the api-ref pages? If possible I think it could be a nice addition to the non-api-ref pages as well, what do you think?), I was thinking we could add the link to some non-api ref pages. I can see putting it in the left-hand nav, but I don't see a great place for it and I think that we would need some discussion before adding it.

@Eric-Arellano Eric-Arellano changed the title Add links to source code Add links to GitHub for non-API pages Jan 10, 2024
@Eric-Arellano
Copy link
Collaborator

Oh. So this is the suggestion to have something like this edit button on every non-API page which will take you back to the Qiskit/documentation repository.

Other projects do that too:

Screenshot 2024-01-10 at 10 50 15 AM

@beckykd
Copy link
Collaborator Author

beckykd commented Jan 10, 2024

If possible I think it could be a nice addition to the non-api-ref pages as well, what do you think?

Oh - so that comment is to have the button on every page; not to just add a link somewhere - got it

@beckykd
Copy link
Collaborator Author

beckykd commented Jan 10, 2024

We're going to wait for the infra fix

@beckykd beckykd closed this as completed Jan 10, 2024
@Eric-Arellano Eric-Arellano closed this as not planned Won't fix, can't repro, duplicate, stale Jan 10, 2024
@Eric-Arellano Eric-Arellano changed the title Add links to GitHub for non-API pages Add links from non-API pages to GitHub for source code Jan 10, 2024
@Eric-Arellano Eric-Arellano changed the title Add links from non-API pages to GitHub for source code Add links from non-API pages to GitHub for API source code Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

2 participants