question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add link to docs page on how to install the Python extension to README

See original GitHub issue

Environment data

  • VS Code version: 1.52.1
  • OS and version: macOS Catalina

I’ve got an existing python flask project, which I run from the command line on macOS using flask run. I’d like to use VS Code, so I tried code ., which opens it up. But instructions online said to install the python extension to VS Code, and links me here.

That page says “Step 2. Install the Python extension for Visual Studio Code.” but doesn’t say how. It took me forever to look in the banner area to notice the Install button. Add “by clicking the Install button above” to make this clearer.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:12 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
luabudcommented, Jan 26, 2021

Hey @JetForMe, thanks for your suggestion! The problem is that our README also shows on our GitHub repo, so “by clicking on the Install button above” wouldn’t make sense there, as there isn’t such a button. I like Brett’s suggestion about linking to the documentation, so something like:

Step 2. Install the Python extension for Visual Studio Code.

Or we can link it directly to the Extension Marketplace docs. I just felt some poeple could be confused as to why they were directed to a doc titled “Extension Marketplace” when they just wanted to install the Python extension.

1reaction
brettcannoncommented, Jan 22, 2021

I think we could link to https://code.visualstudio.com/docs/editor/extension-gallery in the README, but I would rather not tie our README to the Marketplace’s UI as that could change without us knowing.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Link to Pages - ReadMe Documentation
To create a link between pages, start by typing [ and a scrollable menu of available pages to link to will appear. As...
Read more >
Making a PyPI-friendly README
This guide helps you create a README in a PyPI-friendly format and include your README in your package so it appears on PyPI....
Read more >
Writing Your Docs - MkDocs
Linking to pages . When linking between pages in the documentation you can simply use the regular Markdown linking syntax, including the relative...
Read more >
Include my markdown README into Sphinx - Stack Overflow
The simplest way is to use MyST-Parser, which happens to be the extension now recommended in Sphinx docs for handling Markdown.
Read more >
About READMEs - GitHub Docs
You can add a README file to your repository to tell other people why your project is useful, what they can do with...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found