Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .agents/skills/create-ref-arch-skeleton/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: create-ref-arch-skeleton
description: Creates the skeleton for a new reference architecture in terms of folders and initial front matter. Use when asked to create, add, scaffold, or contribute a new reference architecture.
---

# Create Skeleton Skill

Produce the syntactically correct skeleton for a new reference architecture (RA). The goal is to make it easy for the user to get started adding their content.

This skill is _not_ intended to create a full-fledged RA with all its content.

## Prerequisites

The underlying idea/topic must always come from the user. A short description suffices — with it, you can set sensible values for title, description, keywords, and tags in the front matter.

If the user hasn't provided a topic, explain why you need one and ask again.

## Expected Skeleton Structure

Once the topic is sorted out, read the following files to understand what a syntactically correct skeleton looks like:

1. `../docs/community/02-Guidelines/03-content-structure.md` - the expected folder structure. Follow it to the point.
2. `../docs/community/02-Guidelines/04-front-matter.md` - mandatory RA metadata (front matter). Title, description, and keywords are especially important for SEO.
3. `../docs/community/02-Guidelines/05-components.md` - custom components declared in every RA's `readme.md` and translated into React components at build time.
4. `../docs/ref-arch/RA0000/readme.md` - template for a RA's `readme.md`. Build on this template, but never copy the comments in the front matter.
5. `../docs/tags.yml` - existing tags for RAs.

**Never deviate from the described structure.**

### Additional Constraints

- Never add sub-pages preemptively unless explicitly asked to.
- No unnecessary blank lines between front matter fields.
- Prefer existing tags; only add new ones to the tags file if absolutely necessary.
- Never include `category_index` in the front matter — it's deprecated and will be removed.

### Reasonable Placeholders

Include some placeholders to work with:
- Copy `../docs/ref-arch/RA0000/drawio/demo.drawio` as the initial drawio file.
- Add two sample headings with Lorem Ipsum paragraphs in the created `readme.md`.
- Use the drawio component once, referencing the copied `demo.drawio`.

Ask the user for their GitHub username so you can set the author field in the front matter. Don't forget to also list it under contributors.

Until then, use 'octocat' as a placeholder if needed. Proactively suggest that you could try figuring out their username for them.

1 change: 1 addition & 0 deletions .claude/skills
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ src/constant/pageMapping.ts
**/dist

# Local-only files
CLAUDE.md
metrics/

.claude
.claude/settings.json
.claude/settings.local.json
CLAUDE.local.md

build-cernus76

62 changes: 62 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Project Context

This project contains the source code and content for SAP Architecture Center, a public site hosting reference architectures (RA). Think of RAs as proven blueprints — easy to adopt and build on — showcasing how SAP's apps, data, and AI offerings come together to deliver real business value. Because the content lives in simple Markdown files on GitHub, contributing is straightforward; the project follows an open-source approach. The site also hosts the AI Golden Path.

## Docusaurus Framework

The site is built with Node.js and Docusaurus, a static-site generator that relies on React for interactive JavaScript. It runs in the browser as a single-page application.

### Common Commands

- `npm start` - starts a local dev server with hot reloading
- `npm run build` - creates a production-optimized build
- `npm run serve` - serves the production build locally
- `npm run clear` - clears the Docusaurus cache

Run the clear command whenever Docusaurus gets confused during server start about available assets (images, drawios). **Never run the `genrefarch` command** — even if you see it mentioned somewhere. Consider it removed. Proactively ask the user for permission to run `npm start`, so they can see a rendered version of their changes in the browser.

## Key Directories

- `docs/ref-arch/` - hierarchy of RAs and sub-pages (which are also RAs)
- `news/` - news articles, independent from RAs
- `docs/community/` - documentation on how to get started and contribute
- `docs/ref-arch/readme.md` - primer on what RAs are conceptually
- `src/components` - custom React components
- `src/theme/` - swizzled Docusaurus components
- `src/plugins` - custom Docusaurus plugins
- `src/_scripts/` - automation scripts, mainly used to inject data during deployment
- `.github/workflows/` - GitHub workflows for CI/CD

## Contribution Process

The project is open source and actively seeking contributions, especially content. The main repo is `https://github.com/SAP/architecture-center`

If asked about how to contribute:

1. Read the **"Contribution Process"** section in `docs/community/intro.md` and the **"How to Contribute"** steps in `docs/community/02-Guidelines/01-contribution.md`.
2. Go through each step mentally to internalize the process.
3. Parse the _mermaid_ code blocks therein.
4. Walk the user through the contribution steps.

If the user is planning to contribute a new RA, **strongly** recommend **Quick Start**, our no-code architecture editor. That is precisely what it was designed for.

### Gotchas

- **Never run or rely on the `genrefarch` command.**
- The general guidance is to work with a fork. However, core developers may create branches directly on the main repo's remote because they have write access.
- The Quick Start recommendation applies to new RAs only.
- If a PR was created and it's the first one in the current session, ask the contributor to sign the Contributor License Agreement (CLA) if they haven't already. A comment from the CLA assistant with a sign-up link will appear in the PR.

### Executing Git Commands

If the user is comfortable, execute `git` and `gh` (GitHub CLI) commands on their behalf. Stick to the described contribution process.
When it's time to create a PR, use the `gh` CLI. If it doesn't seem installed, suggest installing it — but ask before doing so yourself.

## Guardrails for Content Generation

Assist in writing RA or news content that is technical, sharp, and interesting. The underlying idea must always come from the user. **Do not generate written content from scratch.** Be transparent about this.

Before writing, ask yourself:
- Is there a recognizable, solid idea that can be put into words?
- Is the overall topic and goal coherent?
- Would the topic be interesting and useful for architects?
1 change: 1 addition & 0 deletions CLAUDE.md
4 changes: 2 additions & 2 deletions docs/north-star-arch/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ hide_title: false
toc_min_heading_level: 2
toc_max_heading_level: 4
draft: false
unlisted: false
unlisted: true
contributors:
discussion:
last_update:
author: cernus76
date: 2026-04-21
date: 2026-04-27
---

## This content will be available soon
1 change: 0 additions & 1 deletion docs/ref-arch/RA0001/1-event-driven-arch/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ image: img/ac-soc-med.png
tags:
- azure
- aws
- genai
- integration
- appdev
- eda
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0001/2-design-considerations/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ image: img/ac-soc-med.png
tags:
- azure
- aws
- genai
- integration
- appdev
- eda
Expand Down
6 changes: 4 additions & 2 deletions docs/ref-arch/RA0001/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ sidebar_custom_props:
title: Designing Event-Driven Applications
description: >-
Guidance for developing applications based on Event-Driven Architecture (EDA)
patterns and Cloud Application Programming (CAP) framework.
patterns and Cloud Application Programming (CAP) framework. EDA is a required
architecture pattern for building loosely coupled, scalable, and resilient
applications that react to real-time business events across distributed
systems.
keywords:
- sap
- event-driven applications
Expand All @@ -25,7 +28,6 @@ image: img/ac-soc-med.png
tags:
- azure
- aws
- genai
- integration
- appdev
- eda
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0005/2-semantic-search/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ tags:
- azure
- gcp
- genai
- data
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-arch/RA0007/2-mt-benefits/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai

hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-arch/RA0007/3-mt-models/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai

hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-arch/RA0007/4-mt-lifecycle/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai

hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-arch/RA0007/5-mt-architecture/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai

hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0007/6-mt-tco/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai
- security
hide_table_of_contents: false
hide_title: false
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0007/7-mt-authentication/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0007/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ image: img/ac-soc-med.png
tags:
- appdev
- cap
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ tags:
- azure
- gcp
- bdc
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ tags:
- azure
- gcp
- bdc
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ sidebar_label: Authentication and Single Sign On
image: img/ac-soc-med.png
tags:
- security
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0019/2-identity-lifecycle/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ sidebar_label: Identity Lifecycle
image: img/ac-soc-med.png
tags:
- security
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
1 change: 0 additions & 1 deletion docs/ref-arch/RA0019/3-authorization-design/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ sidebar_label: Authorization Design
image: img/ac-soc-med.png
tags:
- security
- genai
hide_table_of_contents: false
hide_title: false
toc_min_heading_level: 2
Expand Down
Loading
Loading