Home page: three cards and one button; menu labels and structure - #167
Merged
Conversation
…vanced Topic The home page carried five cards and a row of three catalogue pills. Two of the cards were not journeys of their own - Quickstart repeats the hero's first button, and Technical Insight is what you read after the thing runs, not a way in. What is left is the three questions a reader arrives with: look a task up, take it to production, join in. Below the grid, the three pills become one button to resources/samples - the page that says which catalogue answers which question - so the jump off this site happens once, deliberately, instead of three ways at the same rank. Written as markdown inside the block so VitePress resolves the link against the base, rather than a raw href with /docs/ hard-coded in it. The grid override in style.css is gone with them: three cards give `grid-3`, which is already three per row. It existed to stop five cards rendering as four and a lone fifth. Sidebar, two moves: - "Obsolete" was a collapsible group holding one link. Deprecations sits next to Troubleshooting directly now; both copies of that line carry a marker, as the duplicate-line rule in AGENTS.md asks. - Technical Insight becomes the last entry under Advanced Topic instead of a top-level section beside it, and stops being a line of its own in the Guide dropdown, where listing it next to its parent would describe a structure the sidebar no longer has. All 129 pages stay in llms.txt, now in five sections instead of six.
Labels only - the order and the nesting are byte-for-byte what they were, every link in the same place. Four kinds of fix: - A label that disagreed with the page it opens. Reference/References, Release/Release Notes, UI5 Version/UI5 Versions, User Exit/User Exits, Custom Control/Custom Controls, Expression/Expression Binding, ABAP Thinking UI5 Result/Results. The sidebar and the page now say the same word, which is also what the site search shows. - Two different pages both called "Installation" - one under Getting Started, one under Configuration - which are indistinguishable in a search result. The first is now "Install with abapGit"; the second keeps the name, because that is what it is about. - Two groups both called Tool(s), one holding the project's own three and one holding what the framework stands on. "Project Tools" and "Toolchain". The cross-reference comments name the new labels. - Singular section headings next to plural ones: Advanced Topic -> Advanced Topics, Resource -> Resources, in the sidebar and in the Guide dropdown. The generated llms.txt picks the new section names up. Two more, each its own reason: the Guide dropdown said "Introduction" where it opens the section the sidebar calls Getting Started, and Cookbook > Action opens a page titled "Action (Obsolete)" - worth knowing before the click rather than after it. Launchpad -> Fiori Launchpad, which is the product's name and the page's title.
…uplicates Four moves, no page touched and no URL changed - all 129 pages are still in the sidebar and still in the generated llms.txt. Cookbook: "More Topics" is gone and its three chapters - EML/CDS/SQL, Patterns & Helpers, Troubleshooting - sit at chapter level. The group name said nothing, and the click it cost fell on Troubleshooting, one of the most-searched things here, three levels down behind a label that did not name it. Advanced Topics: twelve flat entries of four different kinds become seven. Use Cases and Add-ons stay loose at the top - they are what the section is for - then Extensibility, Integration (RFC, HTTP, Fiori Elements), Releases & Stacks (Downporting, Namespaces, Working Off-Stack, Legacy-Free) and Developer Setup (Local Setup, Project Tools). Technical Insight is now the seventh of seven rather than the twelfth of twelve, which is the cost the previous commit had left in: a section visible only after scrolling. Two duplicate entries removed. The linter stood in both Project Tools and Technical Insight > Toolchain; Toolchain now holds only what the framework stands on, which is what the group's name claims. Deprecations left the Cookbook and keeps its home under Resources. An entry standing twice in one sidebar makes its own search results ambiguous. Resources: License, Support, Contact, Contribution, Sponsor and Logo move into a collapsed "Project" group at the bottom. They stood between the reading destinations and pushed them off the first screen, and each is already reachable from the footer or the version menu. Two things deliberately not done, because they are more than menu: the pages under Cookbook > Troubleshooting > Debugging and State > Logout still live at /configuration/*, and Advanced Topics still lands on Downporting for want of an overview page. Both change URLs or add a page.
check:counts went red on the pull request, and not because of it: nothing in these commits touches resources/samples.md. The Learn catalogue lists 150 apps now where the page still said 152, which makes the total 612 rather than 614 - the kind of figure AGENTS.md warns goes stale without anybody touching this repository, and the reason the gate exists. Verified against a real abap2UI5/samples checkout rather than taken from the CI message: with SAMPLES_HOME set, check:counts says every count matches its catalogue. The other two figures need their own checkouts; CI has them and flagged neither, and 150 + 430 + 32 is the 612 above.
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.
Three commits, home page first and then the menu the home page hands you to. No page content changed and no URL moved — all 129 pages are still in the sidebar and still in the generated
llms.txt.Home page
Five feature cards become three: Cookbook, Configuration, Community. The two that left were not journeys of their own — Quickstart repeats the hero's first button, and Technical Insight is what you read after the thing runs, not a way in.
Below the grid, the three catalogue pills become one button to
resources/samples, the page that says which catalogue answers which question, so the jump off this site happens once and deliberately. Written as markdown inside the block so VitePress resolves the link against the base, rather than a rawhrefwith/docs/hard-coded in it.The column-count override in
style.cssgoes with them: three cards givegrid-3, which is already three per row. It existed to stop five cards rendering as four and a lone fifth.Menu labels
Labels only — order and nesting byte-for-byte unchanged, verified by diffing the rendered tree.
Cookbook > Actionopens a page titled Action (Obsolete), worth knowing before the click; Launchpad → Fiori Launchpad, the product's name and the page's title.Menu structure
More Topicsis dissolved, its three chapters — EML/CDS/SQL, Patterns & Helpers, Troubleshooting — sit at chapter level. The name said nothing, and the click it cost fell on Troubleshooting, three levels down behind a label that did not name it.Deliberately not done
Both are more than menu:
Cookbook > Troubleshooting > DebuggingandState > Logoutstill point at pages living under/configuration/*(moving them changes URLs), andAdvanced Topicsstill lands on Downporting for want of an overview page.Verification
npm run checkgreen locally — test, check:version, docs:build, check:examples.check:samplesandcheck:countsskip without sample checkouts; CI checks them out.Generated by Claude Code