Rework the entry path: landing page, depth pages out of onboarding, one AI page, and docs for the three tools - #156
Merged
Conversation
The front page carried three cards, and two of them (GitHub, LinkedIn) duplicated the social icons that are always visible in the nav bar - while the entries a newcomer actually needs (Cookbook, Samples, Configuration, the live demo) were reachable only through menus. Now: - Hero actions: "Get Started" leads to the quickstart (the button a newcomer wants first), "Introduction" to the about page, and "Live Demo" to the browser build - try it before installing anything, which was buried in a tip on the quickstart page. - Six cards, one per journey, in the order a reader meets them: Quickstart, Cookbook, Samples, Configuration, Technical Insight, Community. "What's new?" stays reachable via the version dropdown. - Below the cards, the hello-world class: nine lines that show the promise of the tagline instead of only stating it. Centered at the site's reading width - the home layout would hand it the full grid width, where code reads as a banner. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
Two pages sat in Getting Started that answer questions a newcomer does not have yet, and there they read as required steps. Both move under Advanced Topic: Use Cases (the extensibility tiers) as-is, and Your Project renamed to Working Off-Stack - what the page is actually about is developing the app repository off the SAP stack, with git, the gates and CI. The AI material lived in three places; now Building with AI is the one page. The Tooling page loses its ai-mcp section and the llms.txt tip (both restated what Building with AI already says) and points there instead; the paste-ahead prompt from the framework README - the only AI content that existed nowhere in this documentation - moves in as the zero-effort first rung of the page's ladder. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
The linter, the MCP server and the VS Code extension are abap2UI5's own tools, and the only thing describing any of them was its README - written for somebody already standing in the repository. Nothing on this site said what an MCP server is, and the extension appeared as one paragraph on the Tooling page. Advanced Topic gains a Tools group with a page per repository: what the tool is, the problem it solves, how to set it up in levels, and every feature explained rather than listed. The linter page moves here from Technical Insight, where it sat among the tools this project BORROWS, and is expanded to the same depth; the entry in that list now points here. The READMEs keep what only makes sense in the repository - quick start, development, packaging, releasing - and point at the page for the rest, so there is one copy to maintain instead of two that drift. Also corrects the MCP server's repository name throughout: ai-mcp was renamed to mcp-server, and every link here still said the old one. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
This was referenced Aug 18, 2026
…esign-ugf6jt # Conflicts: # docs/get_started/ai.md # docs/get_started/next.md # docs/get_started/tooling.md # docs/resources/samples.md
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.
Four changes to the same problem: the way in. What a newcomer meets first was carrying things they do not need yet, while the things they do need were reachable only through menus — or not written at all.
1. Landing page
The front page spent two of its three cards (GitHub, LinkedIn) duplicating the social icons that are always visible in the nav bar, and claimed "Keep it ABAP" without showing a line of it.
2. Depth pages out of Getting Started
Two pages answered questions a newcomer does not have yet, and there they read as required steps. Both move under Advanced Topic:
3. All AI material on one page
It lived in three places. Building with AI is now the one page: the Tooling page loses its ai-mcp section and its
llms.txttip (both restated what that page already said) and points there instead, and the paste-ahead prompt from the framework README — the only AI content that existed nowhere in this documentation — moves in as the zero-effort first rung. (The framework README is shortened to match in abap2UI5/abap2UI5#[companion PR].)4. A documentation page per tool repository
The linter, the MCP server and the VS Code extension are this project's own tools, and the only thing describing any of them was a README written for somebody already standing in the repository — 843 and 991 lines of it. Nothing on this site said what an MCP server even is, and the extension appeared as one paragraph.
Advanced Topic → Tools now has a page per repository, written for somebody who has not decided to use the tool yet: what it is, the problem it solves, setup in levels, and every feature explained rather than listed.
/advanced/linter— moved here from Technical Insight, where it sat among the tools this project borrows, and expanded to the same depth. The entry in that list now points here./advanced/mcp_server— new./advanced/vscode— new.The three READMEs are shortened to their quick start plus development/packaging/releasing and point at these pages, so there is one copy to maintain instead of two that drift (abap2UI5/linter, abap2UI5/mcp-server and abap2UI5/vscode-extension each have a companion PR).
Also corrects the MCP server's repository name throughout:
ai-mcpwas renamed tomcp-server, and every link here still said the old one.Verified
npm test,check:version,docs:build(no dead links, no orphan pages) andcheck:examplesall green;check:samples/check:countsskip without a samples checkout, as documented — this change touches neither samples blocks nor countsllms.txt🤖 Generated with Claude Code
https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG