Skip to content

Follow the walkthrough's new steps - #796

Merged
oblomov-dev merged 1 commit into
mainfrom
claude/ui5-tutorials-page-5yq32e
Aug 21, 2026
Merged

Follow the walkthrough's new steps#796
oblomov-dev merged 1 commit into
mainfrom
claude/ui5-tutorials-page-5yq32e

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

Follow-up to #794. get_started/full_example is being removed in abap2UI5/docs#171 — it was a step-by-step tutorial living outside the tutorial, and its content is now steps 8 to 10 of the walkthrough. The two classes that pointed at it follow it there.

Class Now points at
Z2UI5_CL_SMP_APP_011 cookbook/model/tables, tutorials/walkthrough/step-8 (the selection screen and reading data), tutorials/walkthrough/step-10 (the finished app)
Z2UI5_CL_SMP_APP_070 cookbook/model/tables, tutorials/walkthrough/step-9 (the table with columns, cells and a row action), tutorials/walkthrough/step-10

070 also drops step-8, which is a different page than it was: what stood there is step-10 now. SAMPLES.md is regenerated.

Merge order — and why one check is red here

The two repositories check this pairing symmetrically: link-samples.mjs over there fails when a page declares a class that does not point back, and check:docs-links here fails when a line names a page that does not exist or does not declare the class. When a page is renamed, no merge order leaves both repositories green at once — whichever side goes first names something the other side does not have yet.

So check-docs-links is expected to be red on this PR: it resolves abap2UI5/docs from main, where step-9 and step-10 do not exist yet. Every other job is green. This side has to land first regardless, because docs' deploy workflow runs its gates inside the deploy job — merging docs first would leave main red and the site would not publish.

The sequence is: merge this, then abap2UI5/docs#171, then re-run this check — it goes green once the pages are on docs main.

Verified locally against a checkout of the documentation branch that carries those pages: npm run check green end to end, check:docs-links reporting 97 classes link to 47 pages, every @docs link resolves and points at a page that names it back.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PwxPfiy5WE8fVxfnToFeWk


Generated by Claude Code

get_started/full_example is gone in abap2UI5/docs - it was a
step-by-step tutorial living outside the tutorial, and its content is
now steps 8 to 10 of the walkthrough. The two classes that pointed at it
follow:

  011  step-8  (the selection screen and reading data)
       step-10 (the finished app)
  070  step-9  (the table with columns, cells and a row action)
       step-10

070 also drops step-8, which is a different page than it was: what stood
there is step-10 now.

A `" @docs` line naming a page that no longer exists is exactly what
check:docs-links was written to catch, and it would have gone red on the
next run either way. SAMPLES.md is regenerated.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PwxPfiy5WE8fVxfnToFeWk
Copilot AI lite review requested due to automatic review settings August 21, 2026 09:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@oblomov-dev
oblomov-dev merged commit 3a5596b into main Aug 21, 2026
16 of 17 checks passed
@oblomov-dev
oblomov-dev deleted the claude/ui5-tutorials-page-5yq32e branch August 21, 2026 09:58
oblomov-dev added a commit that referenced this pull request Aug 21, 2026
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
oblomov-dev added a commit 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants