abap2UI5-docs

Welcome! 👋

This repository contains the source files for the abap2UI5 documentation.

Contributing

We appreciate your help! If you spot a typo, want to improve existing content, or have ideas for new topics, feel free to open a pull request or issue.

Every contribution makes the documentation better for the community!

Working on it locally

npm ci
npm run docs:dev     # the site, with hot reload
npm run check        # what CI runs, all six steps

What CI checks

A documentation repository has no compiler for its prose, but six things in it are decidable, and npm run check decides all six before a merge — the prose builds (docs:build), the fenced ABAP examples compile and the views they build name real UI5 API (check:examples), the sample links and the sample counts still match the sample repositories (check:samples, check:counts), the release number in the nav bar still matches the framework (check:version), and the catalogue parser still parses (test). .github/workflows/check.yml runs the same list in the same order, so a green npm run check locally is a green pull request.

AGENTS.md describes each of the six, what a failure means and which of them need a sibling checkout to say anything at all — read it before changing anything beyond prose.

What the site publishes for machines

Besides the site, docs:build writes llms.txt, llms-full.txt and a raw .md next to every .html, so an AI assistant asked about abap2UI5 can read the current documentation instead of guessing from training data. All three are generated on every build and gitignored — never edit them, and nothing needs maintaining: the page list comes from the sidebar, so adding a page there adds it here. AGENTS.md has the details.

Linking a sample from a page

A page lists the samples that demonstrate it in its frontmatter, by class name and nothing else:

---
outline: [2, 4]
samples:
  - z2ui5_cl_smp_app_009
  - z2ui5_cl_smp_app_078
---

npm run link:samples then writes the Working Samples table at the bottom of the page. Do not edit that block — the title, the folder and the URL are read from the sample catalogue, so a sample that gets re-described or moved updates on the next run, and one that gets deleted fails the check instead of leaving a 404 on the site. The one thing a page states is which samples are relevant, which is the one thing the catalogue cannot know.

It needs a samples checkout — SAMPLES_HOME=..., or abap2UI5/samples cloned as a sibling directory. Without one both commands say so and do nothing: the generated blocks are committed, so building the site never needs it.

The link is checked in both directions. A class this documentation points at has to carry a " @docs line naming the page, so somebody who lands in the samples repository from a search engine finds the chapter that explains what they are reading. Add the samples: entry here first, then the " @docs line over there — AGENTS.md §4 in that repository describes it.