From f60b5e37a46de55db831a82346ec8c024f1c4c9b Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 20 Aug 2026 10:54:22 +0000 Subject: [PATCH 1/4] Home page: three cards and one button; fold Technical Insight into Advanced 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. --- docs/.vitepress/config.mjs | 102 ++++++++++++++++++-------------- docs/.vitepress/theme/style.css | 53 ++++++++--------- docs/index.md | 47 +++++++-------- 3 files changed, 101 insertions(+), 101 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index c47e7227..10a8e14b 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -123,8 +123,11 @@ export default defineConfig({ { text: "Introduction", link: "/get_started/about" }, { text: "Cookbook", link: "/cookbook/overview" }, { text: "Configuration", link: "/configuration/setup" }, + // Technical Insight is not a line of its own here any more: it is a + // subsection of Advanced Topic in the sidebar, and a flat dropdown + // that still lists it next to its parent tells the reader a + // different structure than the sidebar they land in. { text: "Advanced Topic", link: "/advanced/downporting" }, - { text: "Technical Insight", link: "/technical/concept" }, { text: "Resource", link: "/resources/references" }, ], }, @@ -356,13 +359,13 @@ export default defineConfig({ { text: "Common Failures", link: "/cookbook/troubleshooting/common_failures" }, ], }, - { - text: "Obsolete", - collapsed: true, - items: [ - { text: "Deprecations", link: "/resources/deprecations" }, - ], - }, + // Was a one-entry "Obsolete" group of its own: a collapsible + // that costs a click to reveal a single link is a level nobody + // needs. The page sits here directly, next to Troubleshooting. + // + // COOKBOOK copy - Resource carries the same entry, pointing at + // the same page. Match on the marker. + { text: "Deprecations", link: "/resources/deprecations" }, // cookbook ], }, ], @@ -458,46 +461,52 @@ export default defineConfig({ }, ], }, - ], - }, - { - text: "Technical Insight", - link: "/technical/concept", - collapsed: true, - items: [ - { text: "UI5 Over-the-Wire", link: "/technical/concept" }, - { text: "ABAP Thinking, UI5 Result", link: "/technical/dx" }, - { text: "Cloud Readiness", link: "/technical/cloud" }, - { text: "Behind the Scenes", link: "/technical/how_it_all_works" }, + // A section of its own until now, next to Advanced Topic rather + // than inside it. It is the same kind of reading - what the + // framework does under the app, and the tools it stands on - and + // it is read after the app runs, not on the way in, so it sits + // here as the last entry instead of as a second top-level heading + // competing with this one. { - text: "Technology", - link: "/technical/technology/overview", + text: "Technical Insight", + link: "/technical/concept", collapsed: true, items: [ - { text: "RAP", link: "/technical/technology/rap" }, - { text: "UI5 Freestyle", link: "/technical/technology/ui5" }, - ], - }, - { - text: "Tool", - collapsed: true, - items: [ - // The project's own linter, next to the tools it borrows. Every - // other gate in this section is somebody else's; this one is - // the only thing that can read a view that does not exist until - // the app runs. - // - // TECHNICAL copy — the page itself lives under Advanced Topic > - // Tools with the MCP server and the extension, the project's - // other two. Match on the marker, not on the text. - { text: "abap2UI5 linter", link: "/advanced/linter" }, // technical - { text: "abapGit", link: "/technical/tools/abapgit" }, - { text: "ajson", link: "/technical/tools/ajson" }, - { text: "S-RTTI", link: "/technical/tools/srtti" }, - { text: "abaplint", link: "/technical/tools/abaplint" }, - { text: "open-abap", link: "/technical/tools/open_abap" }, - { text: "abap-cleaner", link: "/technical/tools/abap_cleaner" }, - { text: "abapmerge", link: "/technical/tools/abapmerge" }, + { text: "UI5 Over-the-Wire", link: "/technical/concept" }, + { text: "ABAP Thinking, UI5 Result", link: "/technical/dx" }, + { text: "Cloud Readiness", link: "/technical/cloud" }, + { text: "Behind the Scenes", link: "/technical/how_it_all_works" }, + { + text: "Technology", + link: "/technical/technology/overview", + collapsed: true, + items: [ + { text: "RAP", link: "/technical/technology/rap" }, + { text: "UI5 Freestyle", link: "/technical/technology/ui5" }, + ], + }, + { + text: "Tool", + collapsed: true, + items: [ + // The project's own linter, next to the tools it borrows. Every + // other gate in this section is somebody else's; this one is + // the only thing that can read a view that does not exist until + // the app runs. + // + // TECHNICAL copy — the page itself lives under Advanced Topic > + // Tools with the MCP server and the extension, the project's + // other two. Match on the marker, not on the text. + { text: "abap2UI5 linter", link: "/advanced/linter" }, // technical + { text: "abapGit", link: "/technical/tools/abapgit" }, + { text: "ajson", link: "/technical/tools/ajson" }, + { text: "S-RTTI", link: "/technical/tools/srtti" }, + { text: "abaplint", link: "/technical/tools/abaplint" }, + { text: "open-abap", link: "/technical/tools/open_abap" }, + { text: "abap-cleaner", link: "/technical/tools/abap_cleaner" }, + { text: "abapmerge", link: "/technical/tools/abapmerge" }, + ], + }, ], }, ], @@ -517,7 +526,8 @@ export default defineConfig({ { text: "Sample Catalogues", link: "/resources/samples" }, { text: "Who Uses abap2UI5?", link: "/resources/who_uses" }, { text: "Release", link: "/resources/changelog" }, - { text: "Deprecations", link: "/resources/deprecations" }, + // RESOURCE copy - see the marker on the Cookbook one. + { text: "Deprecations", link: "/resources/deprecations" }, // resource { text: "License", link: "/resources/license" }, { text: "Support", link: "/resources/support" }, { text: "Contact", link: "/resources/contact" }, diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index a6717422..3ee3469a 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -389,23 +389,19 @@ /* ------------------------------------ the home page, below the hero --- * - * Five feature cards, not six. VPFeatures picks its column count from the - * NUMBER of cards — 6 gives `grid-6` and three per row, 5 gives `grid-4` and - * four in the first row with the fifth alone under it. Five cards is the - * decision (docs/index.md says why samples are not one of them), so the - * column count is set here instead of being an accident of the count. - * `.VPHome` in front only to outrank the component's own scoped rule without - * an `!important`. */ -@media (min-width: 768px) { - .VPHome .VPFeatures .item.grid-4 { - width: calc(100% / 3); - } -} + * Three feature cards. VPFeatures picks its column count from the NUMBER of + * cards, and three gives `grid-3` — three per row, which is the row this page + * wants — so nothing has to be overridden here any more. Change the count in + * docs/index.md and the row changes with it: five would give `grid-4` and a + * lone fifth card under four, which is what the override that used to live + * here existed to prevent. + */ -/* The three sample catalogues, under the grid and deliberately not part of it: - * they are pages published by three OTHER repositories, and every card above - * them stays on this site. A rule, small type and a row of pills — enough to - * read as "and, separately, over there" rather than as a sixth card. +/* The sample catalogues, under the grid and deliberately not part of it: a + * corpus of working apps is a different kind of destination from the cards + * above, and a fourth card would read as one of them. A rule, small type and + * a single button — enough to read as "and, separately, over there" rather + * than as another card. * * The selectors carry the block class twice because this sits inside * `.vp-doc` — VPHomeContent wraps the markdown that follows the frontmatter — @@ -427,33 +423,32 @@ .a2ui5-catalogues .a2ui5-catalogues-links { display: flex; - flex-wrap: wrap; justify-content: center; - gap: 8px 12px; - margin: 16px 0 0; + margin: 20px 0 0; } .a2ui5-catalogues .a2ui5-catalogues-links a { display: inline-flex; align-items: center; gap: 6px; - border: 1px solid var(--vp-c-divider); + border: 1px solid var(--vp-c-brand-1); border-radius: 20px; - padding: 5px 16px; - color: var(--vp-c-text-1); + padding: 8px 22px; + color: var(--vp-c-brand-1); font-size: 14px; - font-weight: 500; + font-weight: 600; text-decoration: none; - transition: border-color 0.25s, color 0.25s; + transition: border-color 0.25s, color 0.25s, background-color 0.25s; } .a2ui5-catalogues .a2ui5-catalogues-links a::after { - content: "↗"; - font-size: 12px; - opacity: 0.55; + content: "→"; + font-size: 13px; + opacity: 0.7; } .a2ui5-catalogues .a2ui5-catalogues-links a:hover { - border-color: var(--vp-c-brand-1); - color: var(--vp-c-brand-1); + border-color: var(--vp-c-brand-2); + background-color: var(--vp-c-brand-soft); + color: var(--vp-c-brand-2); } diff --git a/docs/index.md b/docs/index.md index 98ed5e9a..3d8e0e9a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,22 +23,20 @@ hero: text: Playground link: https://abap2ui5.github.io/playground/ -# One card per reader journey, in the order a newcomer meets them: install, -# look things up, take it to production, understand it, join in. GitHub and -# LinkedIn are NOT cards — both already sit in the nav bar as social icons, -# and a card spent on a link that is always visible is a card not spent on a -# journey. +# Three cards, one per thing a reader comes here to do: look a task up, take +# it to production, join in. Quickstart is not a card — the hero's first +# button is already that jump, and a card repeating it is a card spent twice. +# Technical Insight is not one either: it is what you read after the thing +# runs, not a way in. GitHub and LinkedIn are not cards — both sit in the nav +# bar as social icons, and a card spent on a link that is always visible is a +# card not spent on a journey. # -# Samples are NOT a card either, and that is the one deliberate gap: the three -# catalogues are somewhere else entirely — three published pages, not a page of -# this site — and a card that looks like the five around it and then leaves the -# site is the card people click by accident. They sit below the grid instead, -# set apart, where leaving is the obvious thing to be doing. +# Samples are NOT a card either, and that is the one deliberate gap: the +# catalogues are a reading destination of their own, and a card that looks +# like the three around it and then hands you a corpus is the card people +# click by accident. They sit below the grid instead, as a single button, set +# apart, where leaving the grid is the obvious thing to be doing. features: - - title: Quickstart - icon: - details: Install with abapGit and launch your first app in minutes. - link: /get_started/quickstart - title: Cookbook icon: details: Recipes for everyday tasks — views, binding, tables, events, popups, files. @@ -47,26 +45,23 @@ features: icon: details: Setup, security, performance, launchpad — the road to production use. link: /configuration/setup - - title: Technical Insight - icon: - details: How UI5 over the wire works, and the open-source tools it builds on. - link: /technical/concept - title: Community icon: details: Browse the code, report issues, contribute — the project is built in the open. link: https://github.com/abap2UI5/abap2UI5/ --- -
-

Looking for a working app to copy? The sample catalogues are searchable in the browser — nothing to install.

-

- Learn - Controls - Stack -

+ +Looking for a working app to copy? The sample catalogues are searchable in the browser — nothing to install. +{.a2ui5-catalogues-lead} + +[Browse the Samples](/resources/samples) +{.a2ui5-catalogues-links} +
From f66352d01d74fe05ad97c77bf4c82bca5bc1af3a Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 20 Aug 2026 11:05:05 +0000 Subject: [PATCH 2/4] Menu labels: say what the entry opens, and say it the same way twice 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. --- docs/.vitepress/config.mjs | 49 ++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 10a8e14b..bd001907 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -120,15 +120,17 @@ export default defineConfig({ { text: "Guide", items: [ - { text: "Introduction", link: "/get_started/about" }, + // The section is called Getting Started in the sidebar this opens; + // "Introduction" was the first PAGE in it, one level down. + { text: "Getting Started", link: "/get_started/about" }, // nav { text: "Cookbook", link: "/cookbook/overview" }, { text: "Configuration", link: "/configuration/setup" }, // Technical Insight is not a line of its own here any more: it is a // subsection of Advanced Topic in the sidebar, and a flat dropdown // that still lists it next to its parent tells the reader a // different structure than the sidebar they land in. - { text: "Advanced Topic", link: "/advanced/downporting" }, - { text: "Resource", link: "/resources/references" }, + { text: "Advanced Topics", link: "/advanced/downporting" }, // nav + { text: "Resources", link: "/resources/references" }, // nav ], }, { @@ -161,7 +163,7 @@ export default defineConfig({ // abap2UI5/src/02/z2ui5_if_app.intf.abap is where it comes from text: "1.143.0", items: [ - { text: "Release", link: "/resources/changelog" }, + { text: "Release Notes", link: "/resources/changelog" }, { text: "Support", link: "/resources/support" }, // NAV copy — the sidebar has the same two entries verbatim, further // down under "Resource". Search for this marker, not for the text. @@ -176,11 +178,11 @@ export default defineConfig({ link: "/get_started/about", collapsed: true, items: [ - { text: "Introduction", link: "/get_started/about" }, + { text: "Introduction", link: "/get_started/about" }, // sidebar { text: "Quickstart", items: [ - { text: "Installation", link: "/get_started/quickstart" }, + { text: "Install with abapGit", link: "/get_started/quickstart" }, { text: "Hello World", link: "/get_started/hello_world" }, { text: "Full Example", link: "/get_started/full_example" }, ], @@ -217,7 +219,7 @@ export default defineConfig({ text: "Binding", link: "/cookbook/model/binding", items: [ - { text: "Expression", link: "/cookbook/model/expression_binding" }, + { text: "Expression Binding", link: "/cookbook/model/expression_binding" }, { text: "Formatter", link: "/cookbook/model/formatter" }, ], }, @@ -241,7 +243,7 @@ export default defineConfig({ { text: "Frontend", link: "/cookbook/event_navigation/frontend" }, ], }, - { text: "Action", link: "/cookbook/event_navigation/action" }, + { text: "Action (Obsolete)", link: "/cookbook/event_navigation/action" }, { text: "Follow-up Action", link: "/cookbook/expert_more/follow_up_action" }, { text: "Navigation", link: "/cookbook/event_navigation/navigation" }, { text: "Routing", link: "/cookbook/event_navigation/routing" }, @@ -392,10 +394,10 @@ export default defineConfig({ { text: "Security", link: "/configuration/security" }, { text: "Authorization", link: "/configuration/authorization" }, { text: "Performance", link: "/configuration/performance" }, - { text: "UI5 Version", link: "/configuration/ui5_versions" }, + { text: "UI5 Versions", link: "/configuration/ui5_versions" }, { text: "Production Use", link: "/configuration/productive_usage" }, { text: "Transport", link: "/configuration/transport" }, - { text: "Launchpad", link: "/configuration/launchpad" }, + { text: "Fiori Launchpad", link: "/configuration/launchpad" }, { text: "ABAP Cloud, BTP", collapsed: true, @@ -412,7 +414,7 @@ export default defineConfig({ ], }, { - text: "Advanced Topic", + text: "Advanced Topics", link: "/advanced/downporting", collapsed: true, items: [ @@ -430,11 +432,11 @@ export default defineConfig({ // the documentation for those three repositories, so their READMEs // can stay short and point at a page instead of growing a second // copy that drifts. - text: "Tools", + text: "Project Tools", link: "/advanced/linter", collapsed: true, items: [ - // ADVANCED copy — Technical Insight > Tool carries the same + // ADVANCED copy — Technical Insight > Toolchain carries the same // entry, pointing at the same page. Match on the marker. { text: "abap2UI5 linter", link: "/advanced/linter" }, // advanced { text: "MCP Server", link: "/advanced/mcp_server" }, @@ -451,12 +453,12 @@ export default defineConfig({ collapsed: true, items: [ { - text: "User Exit", + text: "User Exits", link: "/advanced/extensibility/user_exits", }, { text: "Frontend", link: "/advanced/extensibility/frontend" }, { - text: "Custom Control", + text: "Custom Controls", link: "/advanced/extensibility/custom_control", }, ], @@ -473,7 +475,7 @@ export default defineConfig({ collapsed: true, items: [ { text: "UI5 Over-the-Wire", link: "/technical/concept" }, - { text: "ABAP Thinking, UI5 Result", link: "/technical/dx" }, + { text: "ABAP Thinking, UI5 Results", link: "/technical/dx" }, { text: "Cloud Readiness", link: "/technical/cloud" }, { text: "Behind the Scenes", link: "/technical/how_it_all_works" }, { @@ -486,7 +488,7 @@ export default defineConfig({ ], }, { - text: "Tool", + text: "Toolchain", collapsed: true, items: [ // The project's own linter, next to the tools it borrows. Every @@ -494,9 +496,10 @@ export default defineConfig({ // the only thing that can read a view that does not exist until // the app runs. // - // TECHNICAL copy — the page itself lives under Advanced Topic > - // Tools with the MCP server and the extension, the project's - // other two. Match on the marker, not on the text. + // TECHNICAL copy — the page itself lives under Advanced + // Topics > Project Tools with the MCP server and the + // extension, the project's other two. Match on the marker, + // not on the text. { text: "abap2UI5 linter", link: "/advanced/linter" }, // technical { text: "abapGit", link: "/technical/tools/abapgit" }, { text: "ajson", link: "/technical/tools/ajson" }, @@ -512,11 +515,11 @@ export default defineConfig({ ], }, { - text: "Resource", + text: "Resources", link: "/resources/references", collapsed: true, items: [ - { text: "Reference", link: "/resources/references" }, + { text: "References", link: "/resources/references" }, // Several hundred working apps in three repositories, and until this // page the only way to find out which one to open was to know all // three existed. The cookbook links individual samples per chapter; @@ -525,7 +528,7 @@ export default defineConfig({ // catalogues - do not repeat one here, where nothing would. { text: "Sample Catalogues", link: "/resources/samples" }, { text: "Who Uses abap2UI5?", link: "/resources/who_uses" }, - { text: "Release", link: "/resources/changelog" }, + { text: "Release Notes", link: "/resources/changelog" }, // RESOURCE copy - see the marker on the Cookbook one. { text: "Deprecations", link: "/resources/deprecations" }, // resource { text: "License", link: "/resources/license" }, From 2b47877bff5855b9f9ce756280c08d814d06a6c4 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 20 Aug 2026 11:12:39 +0000 Subject: [PATCH 3/4] Menu structure: dissolve two junk drawers, group Advanced, drop two duplicates 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. --- docs/.vitepress/config.mjs | 218 +++++++++++++++++++++---------------- 1 file changed, 124 insertions(+), 94 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index bd001907..4713c784 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -325,49 +325,42 @@ export default defineConfig({ { text: "App State, Share", link: "/cookbook/expert_more/app_state_share" }, ], }, + // Three chapters that sat behind a collapsible called "More Topics" + // until now. The name said nothing, and the click it cost fell on + // Troubleshooting - one of the most-searched pages here, three + // levels deep behind a label that did not name it. Deprecations + // left with the group: it is one page and it has a home under + // Resources, and an entry standing twice in one sidebar makes its + // own search results ambiguous. { - text: "More Topics", + text: "EML, CDS, SQL", link: "/cookbook/eml_cds_sql/rap", collapsed: true, items: [ - { - text: "EML, CDS, SQL", - link: "/cookbook/eml_cds_sql/rap", - collapsed: true, - items: [ - { text: "RAP", link: "/cookbook/eml_cds_sql/rap" }, - { text: "EML", link: "/cookbook/eml_cds_sql/eml" }, - { text: "Draft Handling", link: "/cookbook/eml_cds_sql/draft_handling" }, - { text: "CDS", link: "/cookbook/eml_cds_sql/cds" }, - { text: "ABAP SQL", link: "/cookbook/eml_cds_sql/abap_sql" }, - ], - }, - { - text: "Patterns, Helpers", - collapsed: true, - items: [ - { text: "Snippets", link: "/cookbook/expert_more/snippets" }, - { text: "Value Help", link: "/cookbook/expert_more/value_help" }, - { text: "Demo Output", link: "/cookbook/expert_more/demo_output" }, - { text: "E-Mail", link: "/cookbook/expert_more/email" }, - { text: "Fuzzy Search", link: "/cookbook/eml_cds_sql/fuzzy_search" }, - ], - }, - { - text: "Troubleshooting", - collapsed: true, - items: [ - { text: "Debugging", link: "/configuration/debugging" }, - { text: "Common Failures", link: "/cookbook/troubleshooting/common_failures" }, - ], - }, - // Was a one-entry "Obsolete" group of its own: a collapsible - // that costs a click to reveal a single link is a level nobody - // needs. The page sits here directly, next to Troubleshooting. - // - // COOKBOOK copy - Resource carries the same entry, pointing at - // the same page. Match on the marker. - { text: "Deprecations", link: "/resources/deprecations" }, // cookbook + { text: "RAP", link: "/cookbook/eml_cds_sql/rap" }, + { text: "EML", link: "/cookbook/eml_cds_sql/eml" }, + { text: "Draft Handling", link: "/cookbook/eml_cds_sql/draft_handling" }, + { text: "CDS", link: "/cookbook/eml_cds_sql/cds" }, + { text: "ABAP SQL", link: "/cookbook/eml_cds_sql/abap_sql" }, + ], + }, + { + text: "Patterns, Helpers", + collapsed: true, + items: [ + { text: "Snippets", link: "/cookbook/expert_more/snippets" }, + { text: "Value Help", link: "/cookbook/expert_more/value_help" }, + { text: "Demo Output", link: "/cookbook/expert_more/demo_output" }, + { text: "E-Mail", link: "/cookbook/expert_more/email" }, + { text: "Fuzzy Search", link: "/cookbook/eml_cds_sql/fuzzy_search" }, + ], + }, + { + text: "Troubleshooting", + collapsed: true, + items: [ + { text: "Debugging", link: "/configuration/debugging" }, + { text: "Common Failures", link: "/cookbook/troubleshooting/common_failures" }, ], }, ], @@ -418,36 +411,19 @@ export default defineConfig({ link: "/advanced/downporting", collapsed: true, items: [ - // Both moved out of Getting Started on purpose: the extensibility - // tiers and the git/CI project setup answer questions a newcomer - // does not have yet, and on the entry pages they read as required - // steps. Here they sit with the other depth topics. + // Twelve entries in a flat list until now, of four different kinds: + // what you can build with it, where you can run it, what it talks + // to, and what you extend. Grouped by that, the section is seven + // entries and Technical Insight - the last of them - is visible + // without scrolling, which it was not when it was the twelfth. + // + // Use Cases and Add-ons stay loose at the top: both moved out of + // Getting Started on purpose, because they answer questions a + // newcomer does not have yet, and on the entry pages they read as + // required steps. They are the two that say what this section is + // for, so they are what a reader opening it meets first. { text: "Use Cases", link: "/advanced/use_cases" }, { text: "Add-ons", link: "/advanced/addons" }, - { text: "Downporting", link: "/advanced/downporting" }, - { text: "Namespaces, Renaming", link: "/advanced/renaming" }, - { text: "Working Off-Stack", link: "/advanced/working_off_stack" }, - { - // The project's own tools, each documented in full here — this is - // the documentation for those three repositories, so their READMEs - // can stay short and point at a page instead of growing a second - // copy that drifts. - text: "Project Tools", - link: "/advanced/linter", - collapsed: true, - items: [ - // ADVANCED copy — Technical Insight > Toolchain carries the same - // entry, pointing at the same page. Match on the marker. - { text: "abap2UI5 linter", link: "/advanced/linter" }, // advanced - { text: "MCP Server", link: "/advanced/mcp_server" }, - { text: "VS Code Extension", link: "/advanced/vscode" }, - ], - }, - { text: "Local Setup", link: "/advanced/local" }, - { text: "RFC Connector", link: "/advanced/rfc" }, - { text: "HTTP Connector", link: "/advanced/http" }, - { text: "Fiori Elements Integration", link: "/advanced/fiori" }, - { text: "UI5 Legacy-Free", link: "/advanced/legacy_free" }, { text: "Extensibility", collapsed: true, @@ -463,7 +439,53 @@ export default defineConfig({ }, ], }, - // A section of its own until now, next to Advanced Topic rather + { + // What the app talks to on the outside. Three pages that were + // three unrelated-looking lines in the flat list. + text: "Integration", + collapsed: true, + items: [ + { text: "RFC Connector", link: "/advanced/rfc" }, + { text: "HTTP Connector", link: "/advanced/http" }, + { text: "Fiori Elements Integration", link: "/advanced/fiori" }, + ], + }, + { + // Where it runs: an older release, a renamed namespace, a system + // the framework is not installed on, a UI5 runtime without the + // legacy libraries. Every one of them is the same question - + // will this work on MY system - asked about a different axis. + text: "Releases, Stacks", + collapsed: true, + items: [ + { text: "Downporting", link: "/advanced/downporting" }, + { text: "Namespaces, Renaming", link: "/advanced/renaming" }, + { text: "Working Off-Stack", link: "/advanced/working_off_stack" }, + { text: "UI5 Legacy-Free", link: "/advanced/legacy_free" }, + ], + }, + { + // The machine you develop on, and the three tools the project + // ships for it - each documented in full here, so their READMEs + // can stay short and point at a page instead of growing a second + // copy that drifts. + text: "Developer Setup", + collapsed: true, + items: [ + { text: "Local Setup", link: "/advanced/local" }, + { + text: "Project Tools", + link: "/advanced/linter", + collapsed: true, + items: [ + { text: "abap2UI5 linter", link: "/advanced/linter" }, + { text: "MCP Server", link: "/advanced/mcp_server" }, + { text: "VS Code Extension", link: "/advanced/vscode" }, + ], + }, + ], + }, + // A section of its own until now, next to Advanced Topics rather // than inside it. It is the same kind of reading - what the // framework does under the app, and the tools it stands on - and // it is read after the app runs, not on the way in, so it sits @@ -491,16 +513,13 @@ export default defineConfig({ text: "Toolchain", collapsed: true, items: [ - // The project's own linter, next to the tools it borrows. Every - // other gate in this section is somebody else's; this one is - // the only thing that can read a view that does not exist until - // the app runs. - // - // TECHNICAL copy — the page itself lives under Advanced - // Topics > Project Tools with the MCP server and the - // extension, the project's other two. Match on the marker, - // not on the text. - { text: "abap2UI5 linter", link: "/advanced/linter" }, // technical + // Every one of these is somebody else's project, which is + // what this group is: the toolchain abap2UI5 stands on. + // The project's own linter used to head the list, pointing + // at the same page as Developer Setup > Project Tools two + // groups up. One entry standing twice in one sidebar makes + // its own search results ambiguous, and here it also made + // the group claim something it no longer holds. { text: "abapGit", link: "/technical/tools/abapgit" }, { text: "ajson", link: "/technical/tools/ajson" }, { text: "S-RTTI", link: "/technical/tools/srtti" }, @@ -529,22 +548,33 @@ export default defineConfig({ { text: "Sample Catalogues", link: "/resources/samples" }, { text: "Who Uses abap2UI5?", link: "/resources/who_uses" }, { text: "Release Notes", link: "/resources/changelog" }, - // RESOURCE copy - see the marker on the Cookbook one. - { text: "Deprecations", link: "/resources/deprecations" }, // resource - { text: "License", link: "/resources/license" }, - { text: "Support", link: "/resources/support" }, - { text: "Contact", link: "/resources/contact" }, - // SIDEBAR copy — the nav bar has the same two entries verbatim, - // further up under the version number. Search for this marker, not - // for the text. - { text: "Contribution", link: "/resources/contribution" }, // sidebar - { text: "Sponsor", link: "/resources/sponsor" }, // sidebar - // The logo, the favicon and the cover image, for anyone writing - // about abap2UI5. The page existed and no sidebar linked it, so the - // only way in was knowing the URL - which nobody looking for a logo - // does. Found by scripts/generate-llms.mjs, which reports a page in - // the tree that no sidebar navigates to. - { text: "Logo, Press Kit", link: "/resources/logo" }, + { text: "Deprecations", link: "/resources/deprecations" }, + { + // The project rather than the framework: what it costs, who to + // ask, how to join in. Six entries that stood between the + // reading destinations above and pushed them off the first + // screen - and every one of them is already reachable twice + // over, from the footer and the version menu. Collapsed, at the + // bottom, where a reader goes looking for them on purpose. + text: "Project", + collapsed: true, + items: [ + { text: "License", link: "/resources/license" }, + { text: "Support", link: "/resources/support" }, + { text: "Contact", link: "/resources/contact" }, + // SIDEBAR copy — the nav bar has the same two entries verbatim, + // further up under the version number. Search for this marker, + // not for the text. + { text: "Contribution", link: "/resources/contribution" }, // sidebar + { text: "Sponsor", link: "/resources/sponsor" }, // sidebar + // The logo, the favicon and the cover image, for anyone writing + // about abap2UI5. The page existed and no sidebar linked it, so + // the only way in was knowing the URL - which nobody looking for + // a logo does. Found by scripts/generate-llms.mjs, which reports + // a page in the tree that no sidebar navigates to. + { text: "Logo, Press Kit", link: "/resources/logo" }, + ], + }, ], }, ], From 1e76981a8d98ed660a88d2e0a5a54ce295e8aff9 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 20 Aug 2026 11:31:19 +0000 Subject: [PATCH 4/4] Sample counts: 152 -> 150, and the total with it 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. --- docs/resources/samples.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/resources/samples.md b/docs/resources/samples.md index c07062d6..7beb046f 100644 --- a/docs/resources/samples.md +++ b/docs/resources/samples.md @@ -3,7 +3,7 @@ outline: [2, 4] --- # Sample Catalogues -**614 working apps, in three repositories.** Every one is a single ABAP class +**612 working apps, in three repositories.** Every one is a single ABAP class that compiles, renders, and is downported to three releases — so a sample is never a fragment you have to trust, it is an app you can pull and run. @@ -12,7 +12,7 @@ time than reading this page. | | | you are asking | |---|--:|---| -| [**Learn**](https://abap2ui5.github.io/samples/) — abap2UI5/samples, [catalogue](https://github.com/abap2UI5/samples/blob/main/SAMPLES.md) | 152 | *“Where do I start?”* — value help, navigation between apps, trees, tables, timers, file up- and download. Runs on a bare abap2UI5 install. | +| [**Learn**](https://abap2ui5.github.io/samples/) — abap2UI5/samples, [catalogue](https://github.com/abap2UI5/samples/blob/main/SAMPLES.md) | 150 | *“Where do I start?”* — value help, navigation between apps, trees, tables, timers, file up- and download. Runs on a bare abap2UI5 install. | | [**Controls**](https://abap2ui5.github.io/samples-controls/) — abap2UI5/samples-controls, [catalogue](https://github.com/abap2UI5/samples-controls/blob/main/SAMPLES.md) | 430 | *“Which control does what?”* — the UI5 demo kit, rebuilt control by control, grouped by library. | | [**Stack**](https://abap2ui5.github.io/samples-stack/) — abap2UI5/samples-stack, [catalogue](https://github.com/abap2UI5/samples-stack/blob/main/SAMPLES.md) | 32 | *“Will my system run it?”* — OData, RAP, APC, MIME, the Fiori Launchpad. Each needs something the framework alone does not give you. | @@ -40,7 +40,7 @@ disagree: The pages are the better answer to *"is there a sample for X"*, because they filter; the catalogues are the better answer to *"show me everything"*. The page for **Learn** deliberately shows only the portable subset that survives -every build, so it lists fewer apps than the 152 the catalogue counts. +every build, so it lists fewer apps than the 150 the catalogue counts. ## The pages have the same shape on purpose