README: point at the documentation page instead of carrying it - #63
Merged
Conversation
Nine hundred lines of feature prose, the settings table and the command table were the only documentation this extension had, and they were in the place a user reaches last. They now live at https://abap2ui5.github.io/docs/advanced/vscode.html, organised by what somebody is trying to do rather than by feature. What stays here is installing it, a summary of what it gives you, and the repository's own half: development, packaging, releasing, contributing. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
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
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.
This README was 991 lines — a feature list, then a section per feature, then the settings and command tables. It was also the extension's only documentation, which put every one of those explanations in the place a user reaches last, and organised them by feature rather than by what somebody is trying to do.
The full documentation now lives at https://abap2ui5.github.io/docs/advanced/vscode.html, organised by task: running the app (F9, systems, why there is a proxy, reload on activation, what the preview gives you beyond a browser tab), checking views while you type, writing the view (completion, hover, formatting, the refactorings), seeing the view and the structure, starting from a template, the two MCP servers, what works in the browser, and the settings worth knowing.
What stays here is installing it — including the pre-Marketplace
.vsixnote — a summary of what it gives you, and the repository's own half: development, packaging, releasing, contributing, license.Companion PR: abap2UI5/docs#156, which adds the page.
🤖 Generated with Claude Code
https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
Generated by Claude Code