Skip to content

docs(samples): publish 7 directive-syntax sample tutorials - #15

Merged
jung-thomas merged 1 commit into
mainfrom
docs/publish-directive-syntax-samples
Nov 6, 2026
Merged

jung-thomas merged 1 commit into
mainfrom
docs/publish-directive-syntax-samples

Conversation

@jung-thomas

@jung-thomas jung-thomas commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Publishes 7 sample tutorials that demonstrate the new directive-grammar / markdown-syntax features, drafted during development of those features in sap-tutorials/tutorials-ims and now batch-published here per Tom's plan (foundation + 7 features merged to tutorials-ims DEV as #3021–#3028).

Each lives at tutorials/<slug>/<slug>.md, adapted to this repo's v2-parser frontmatter convention (matching tutorials/v2-example-tutorial and tutorials/tutorial-callout-reference): parser: v2, primary_tag, tags, time, author_name/author_profile, a # Title + <!-- description --> line, and ### H3 step headings. In-repo scratch markers (publish: false, private: true, NOT PUBLISHED notices) were removed. Several drafts used ## (H2) step headings or omitted parser: v2 — both make the tutorial parse to 0 steps and fail the structural CI gate — so steps were normalised to ### H3 and parser: v2 added throughout.

The 7 samples

Slug Feature demonstrated
directive-synced-option-tabs syncTabs frontmatter + sync= OPTION-group qualifier
directive-ui-instructions :menu :ui :icon :kbd :ask UI-instruction directives
directive-callouts alert callouts + collapsible DETAILS/TROUBLESHOOT/HINT/SOLUTION/RESULT + :spoiler + :::type[Title] forms
directive-code-blocks console blocks, diff markers, placeholders: auto, tree fences, :::walkthrough
directive-rich-media :::figure, :image, ::compare, ::diagram, image hotspots, ::cast, sortable/filterable tables
directive-content-reuse ::include snippets, :note/:help/:api/:tutorial/:since reference links, testedWith, ::requires
directive-authoring-aids %% … %% author notes, :::qa-only blocks, deprecated-cli freshness lint

Validation

  • Structural CI gate (the only blocking check in tutorial-pr-checks): all 7 pass — frontmatter present, parser: v2, ≥1 ### step each.
  • All files are LF (no CRLF).
  • markdownlint/cspell/lychee findings are advisory (notify-only) in this repo's CI.

_snippets resolution (please confirm)

directive-content-reuse uses ::include[btp-trial-setup]{region=eu10}. The tutorials-ims include resolver (scripts/parsers/directives/include.ts) resolves a label by matching any snippet key ending with /_snippets/<label>, i.e. a repo-root _snippets/ directory — so I placed the snippet at _snippets/btp-trial-setup.md (repo root), not inside the tutorial folder. Two caveats to flag:

  1. This repo has no prior _snippets/ directory and no existing meta-tutorial uses ::include, so the repo-root _snippets/ convention is unverified end-to-end here — it matches the resolver's expected form but hasn't been exercised against a real fetch of this repo.
  2. In tutorials-ims DEV, the snippet pre-fetch that feeds the resolver is still a stub (fetch-tutorials.ts passes an empty snippet map; TODO "content-reuse Task 8+"). Until that lands, the ::include in this sample will not expand when the platform fetches it. Flagging for follow-up — the sample's syntax is correct and the snippet is colocated correctly for when pre-fetch is wired.

Companion cleanup PR in tutorials-ims removes the in-repo drafts: sap-tutorials/tutorials-ims#3030

@sap-tutorials-builder

Copy link
Copy Markdown

Content (19)

  • _snippets/btp-trial-setup.md:1 — Required frontmatter field missing or empty: time
  • _snippets/btp-trial-setup.md:1 — Required frontmatter field missing or empty: author_name
  • _snippets/btp-trial-setup.md:1 — Required frontmatter field missing or empty: author_profile
  • _snippets/btp-trial-setup.md:1 — Required frontmatter field missing or empty: tags
  • _snippets/btp-trial-setup.md:1 — Required frontmatter field missing or empty: primary_tag
  • _snippets/btp-trial-setup.md:1 — Tutorial has no H1 heading and no title in frontmatter
  • _snippets/btp-trial-setup.md:1 — Missing '## You will learn' section
  • _snippets/btp-trial-setup.md:1 — Missing '## Prerequisites' section
  • _snippets/btp-trial-setup.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • _snippets/btp-trial-setup.md:1 — Markdown file is not under tutorials// — tutorials placed in the wrong folder will 404 (see "new tutorial 404s = wrong repo folder" gotcha). Got: _snippets/btp-trial-setup.md
  • _snippets/btp-trial-setup.md:1 — Tutorial parses to 0 steps: no [ACCORDION-BEGIN [Step N:...]] markers found (legacy v1) and no parser: v2 frontmatter. A tutorial with 0 steps is rejected by the publish guard and skipped by a full rebuild.
  • tutorials/directive-authoring-aids/directive-authoring-aids.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • tutorials/directive-authoring-aids/directive-authoring-aids.md:1 — Tag not in canonical taxonomy: topic>developer-tools
  • tutorials/directive-callouts/directive-callouts.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • tutorials/directive-content-reuse/directive-content-reuse.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • tutorials/directive-rich-media/directive-rich-media.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • tutorials/directive-synced-option-tabs/directive-synced-option-tabs.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')
  • tutorials/directive-synced-option-tabs/directive-synced-option-tabs.md:39 — [OPTION BEGIN] count (0) does not match [OPTION END] count (6)
  • tutorials/directive-ui-instructions/directive-ui-instructions.md:1 — No step headings found (expected at least one '## ' heading that is not 'You will learn' or 'Prerequisites')

Checked 32a901c • ❌ structural errors block this PR check; other findings are notify-only

@jung-thomas
jung-thomas merged commit 89cf72e into main Nov 6, 2026
1 check failed
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.

1 participant