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.

Sign up for GitHub

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

Jump to bottom

Open github.dev from a Read the Docs documentation page #82

Open
kolibril13 opened this issue Nov 29, 2021 · 4 comments
Open

Open github.dev from a Read the Docs documentation page #82

kolibril13 opened this issue Nov 29, 2021 · 4 comments
Labels
Feature New feature Needed: design decision A core team decision is required

Comments

@kolibril13
Copy link

GitHub has a new feature to quickly access an online version of VS Code (github.dev) by pressing "." in any repository.

When a similar feature would be there at readthedocs, it would enable the following workflow:

  1. One reads a doc page generated by sphinx
  2. One finds a typo and can directly enter the github.dev environment at the corresponding .rst file by pressing a keyboard shortcut or a button in the readthedocs footer Menu
  3. One can quickly correct the typo and make a pull request without leaving the browser.
@humitos humitos added Feature New feature Needed: design decision A core team decision is required labels Nov 29, 2021
@Daltz333
Copy link

I'm not sure this really adds any net benefit in simplicity over the GitHub webui.

@kolibril13
Copy link
Author

Here are some benefits I can think of:

  • working with Jupyter notebooks for documenting (nbsphinx) would be easier:

GitHub webui:

image

github.dev:

image

  • changing lines in multiple files would be easier
  • One can use the search option in VS Code that searches the whole code base, e.g. when a typo is made multiple times.
  • One can use custom VS code keybindings

@humitos humitos changed the title Feature request: opening github.dev from readthedocs Open github.dev from a Read the Docs documentation page Jul 24, 2023
@humitos
Copy link
Member

humitos commented Jul 24, 2023

This could be a potential idea for the new addons. I'm moving the issue to its repository.

@humitos humitos transferred this issue from readthedocs/readthedocs.org Jul 24, 2023
humitos added a commit that referenced this issue Jul 24, 2023
@humitos
Visual Studio Code: POC to open VSC on the current file
f18d0cd 
This a small POC to open VSC when hitting `.` on a documentation page.
We still need to find out how to get the URL we want to open in a reliable way.

Closes #82
@humitos humitos mentioned this issue Jul 24, 2023
Closed
@humitos
Copy link
Member

humitos commented Apr 11, 2024 •
edited
Loading

Once we have defined how to convert a URL -> source file and vice-versa (see readthedocs/actions#4 for the same problem), this will be pretty easy to implement as an optional addon as shown in #83

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature New feature Needed: design decision A core team decision is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Visual Studio Code: POC to open VSC on the current file readthedocs/addons
3 participants
@humitos @Daltz333 @kolibril13