Make Tutorials the home of the step-by-step material - #171
Merged
Conversation
The Tutorials section was added next to two pages that were already
tutorials, which is one section too many: Full Example walks "Step 1" to
"Step 5" under Getting Started, and Hello World walked the same first
four steps as the Walkthrough does. A reader met the same material
twice, in two places, with no way to tell which one was the path.
So the section becomes the one place the step-by-step material is
listed:
- Full Example and the Cheat Sheet move INTO it. Only the sidebar
entry moves - both pages keep the URL they were published under, so
no inbound link and no `" @docs` backlink from abap2UI5/samples
breaks. Neither is listed twice; an entry standing in two sections
makes its own search results ambiguous.
- Hello World shrinks to what its name says: the class, how to start
it, the ABAP-language-versions note, and the way on. Its four
explanatory sections were the Walkthrough's steps 1-4 written a
second time. What was NOT already there moved rather than went: the
z2ui5_if_app listing is now step 1, the Ctrl+F12 developer tools are
step 2 - next to the view whose XML they show.
- The Walkthrough's steps stay expanded in the sidebar. A tutorial
whose sequence is behind one more click reads as a single long page.
The Cookbook loses its overview page in the same move. It is a
collection of concrete problem-and-solution chapters, and a map in front
of it was a stop between the reader and the recipe that restated the
sidebar they were already looking at. The section, the nav entry and the
home-page card open on the first chapter; the four pages that linked the
map now link that chapter, and the Cheat Sheet drops the line that
pointed at it.
Gates green: the five checks, and the samples pairing in both directions
(46 pages, 117 links).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PwxPfiy5WE8fVxfnToFeWk
oblomov-dev
added a commit
to abap2UI5/samples
that referenced
this pull request
Aug 21, 2026
get_started/full_example is removed in abap2UI5/docs#171; its content is now steps 8 to 10 of the walkthrough, and the two classes that pointed at it follow it there. 011 -> step-8 (selection screen, reading data) and step-10 (the finished app) 070 -> step-9 (table with columns, cells, row action) and step-10 check-docs-links is red at merge time by necessity: the two repositories check this pairing symmetrically, so a page rename cannot leave both green at once. This side lands first because docs' deploy runs its gates inside the deploy job. The check goes green once docs#171 is on main.
oblomov-dev
added a commit
to abap2UI5/samples
that referenced
this pull request
Aug 21, 2026
…ale statements (#798) * Point 011 and 070 back at pages that exist, and stop a comment saying "two-way" #796 moved the two `" @docs` lines to walkthrough steps 8 to 10, on the expectation that abap2UI5/docs#171 would create them. Docs took a different route: the walkthrough ends at step 8 (App Structure), and `get_started/full_example` - the page #796 dropped - is still there and still declares both classes in its `samples:` frontmatter. So both sides were red. The links now say what is actually published: - 011 -> `get_started/full_example`, `cookbook/model/tables` - 070 -> the same two plus `tutorials/walkthrough/step-8`, whose frontmatter names 070 `check:docs-links` here and `check:samples` in abap2UI5/docs are both green again, and SAMPLES.md is regenerated. Two more, unrelated: - 448's comment called `_bind( )` a "two-way binding", which AGENTS.md §2 asks nobody to do - in comments as much as in titles. - `generate-samples-md.mjs` said "three classes in src/00/98 ... are data objects". There are two, and the file already renders the count from `dataObjects` a few lines down, so the comment now points at that instead of repeating a number that goes stale. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XJBaqq5cFVUVMGr1BQvSVC * AGENTS.md pointed at cs_event-history_back, which 1.143.0 removed The client-API table told an agent that "history back rides `follow_up_action( cs_event-history_back )`". That constant is gone from `z2ui5_if_client` since 1.143.0 - the release this repository pins - so code written from that line does not compile. Nothing caught it: check:prose resolves class NAMES, not constants. Replaced with what app 322 in this repository actually does (the raw `history.back()` handed to `follow_up_action( )`), plus `nav_app_leave( )` for going back inside the app, and the routing entry spelled the way the framework takes it today. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XJBaqq5cFVUVMGr1BQvSVC * Follow the walkthrough to ten steps: 011 and 070 point where #796 aimed When I changed these two `" @docs` lines, `get_started/full_example` still existed and the walkthrough ended at step 8, so pointing there was what resolved. abap2UI5/docs has since done what #796 expected: the walkthrough grew to ten steps, Full Example was folded into them and the page is gone. So the targets go back to exactly what #796 wrote, and they now resolve on both sides: - 011 -> step-8 (selection screen) and step-10 (the finished app) - 070 -> step-9 (tables) and step-10 Each of those pages names the class back in its `samples:` frontmatter. check-docs-links is green against the docs checkout, and SAMPLES.md is regenerated. The other two fixes from that commit are untouched: 448's comment no longer says "two-way", and generate-samples-md.mjs no longer states a data-object count that goes stale. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XJBaqq5cFVUVMGr1BQvSVC --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
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.
Follow-up to #170, which added the Tutorials section. That section landed next to two pages that were already tutorials, and this resolves the redundancy.
The problem
get_started/full_example.mdwalks "Step 1" to "Step 5" — it is a tutorial, sitting under Getting Started.get_started/hello_world.mdwalked the same first four steps as the new Walkthrough does.A reader met the same material twice, in two places, with no way to tell which one was the path.
What changes
Tutorials becomes the one place the step-by-step material is listed.
" @docsbacklink from abap2UI5/samples breaks. Neither is listed twice: an entry standing in two sections makes its own search results ambiguous.z2ui5_if_applisting is now step 1, the Ctrl+F12 developer tools are step 2, next to the view whose XML they show.collapsed: false). A tutorial whose sequence is behind one more click reads as a single long page. Step labels are1.…8.rather than1 —.The Cookbook loses its overview page in the same move. It is a collection of concrete problem-and-solution chapters, and a map in front of it was a stop between the reader and the recipe that restated the sidebar they were already looking at. The section, the nav entry and the home-page card open on the first chapter (
/cookbook/view/definition); the four pages that linked the map now link that chapter, and the Cheat Sheet drops the line that pointed at it.The samples pairing is wired in both directions. Seven step pages declare their sample in
samples:frontmatter; the eight classes point back with" @docs. The companion change is abap2UI5/samples#136 — merge this one first, becausecheck:docs-linksover there resolves this repository frommainon CI.Verification
All five gates green:
test,check:version,docs:build,check:examples(50 view-building examples from 34 pages),check:samples(46 pages, 117 links, up to date). Build has no dead links and reports no orphan pages.🤖 Generated with Claude Code
https://claude.ai/code/session_01PwxPfiy5WE8fVxfnToFeWk
Generated by Claude Code