Merge the two debugging guides into one, and lead with installing the extension - #58
Merged
Merged
Conversation
…nsion There were two overlapping pages — "Debugging" and "Debugging .pyxl files" — so a reader had to find both to get the whole picture, and neither told them the thing they need first: install the extension. They are now one guide. It opens with installing Pyxle Language Tools (the Marketplace link, the `code --install-extension` command, and the Extensions-view route), states the two requirements that actually bite — pyxle-framework 0.8.0 or newer in the selected interpreter, and the Python extension for Python-side breakpoints — and only then gets to F5. The reference material that was previously split across both pages (how the mapping works, the `--inspect` flags, attaching any DAP client, the discovery file, caveats, troubleshooting, the symptom table) follows in one place. Adds a troubleshooting entry for the "No module named pyxle.__main__" case, which means the interpreter has a pre-0.8.0 framework, and notes that the browser-served source map carries only the JSX lines. Every inbound link across the docs, the CLI reference and the changelog now points at the single page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There were two overlapping pages — Debugging and Debugging .pyxl files — so a reader had to find both to get the whole picture. Worse, neither led with the thing you need before any of it works: install the extension.
They are now one guide at
guides/debugging.md.What changed
code --install-extension pyxle.pyxle-language-tools, and the Extensions-view route — followed by the two requirements that actually bite: pyxle-framework 0.8.0 or newer in the interpreter VS Code has selected (the launch runspython -m pyxle, which earlier versions don't provide), and the Python extension for Python-side breakpoints.--inspectflags, attaching any DAP client, the discovery file, reading compiled output, static checks, caveats, troubleshooting and the symptom table.No module named pyxle.__main__, which means the selected interpreter has a pre-0.8.0 framework.@serverhalf of a.pyxlis never sent to a client.docs/README.md, the changelog,studio.md,editor-setup.mdand the CLI reference — now points at the single page, with link text updated to match.Verification
Checked every relative link and anchor in the touched files: zero broken. The anchor the changelog deep-links to (
#quick-start-breakpoints-in-a-pyxl-file) resolves. A repo-wide sweep finds no remainingdebugging-pyxlreference.The site side lands separately: nav and search keywords merged, the stale generated page removed, and the old URL returns a real 404 with the "Back to docs" page rather than stale duplicate content.