This repository was archived by the owner on Apr 13, 2026. It is now read-only.
chore: Add summaries for section overview pages#734
Merged
morri-son merged 6 commits intoMar 5, 2026
Merged
Conversation
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
✅ Deploy Preview for open-component-model ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
1 task
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis pull request enhances documentation infrastructure by updating five documentation index pages with improved descriptions and structured learning paths, adding CSS styling for details/summary elements, and expanding a spell-check wordlist. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~18 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
assets/scss/common/_components.scss (1)
115-117: Prefer inheriting summary typography instead of hard-coding 0.95rem.Using
inheritkeeps<summary>text automatically aligned with surrounding docs text when base typography changes.Proposed tweak
.docs-content details summary { - font-size: 0.95rem; /* Kleinerer Text als normaler Absatz */ + font-size: inherit; + line-height: inherit; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@assets/scss/common/_components.scss` around lines 115 - 117, The summary rule currently hard-codes font-size: 0.95rem in the .docs-content details summary selector; replace the fixed value with font-size: inherit so the <summary> inherits surrounding document typography and stays consistent when base sizes change (update the .docs-content details summary declaration to remove 0.95rem and use inherit).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/docs/getting-started/_index.md`:
- Line 19: Fix the stray asterisk in the second list item: locate the line
containing "2. [Create Component Versions]({{< relref
"create-component-version.md" >}})*- Bundle and store your software artifacts"
and remove the extraneous "*" so the line reads "...}}) - Bundle and store your
software artifacts" (i.e., ensure there's just a space and a hyphen after the
closing ref).
In `@content/docs/overview/_index.md`:
- Line 11: The intro sentence "Discover the Open Component Model (OCM) - a model
and toolkit for a secure delivery for sovereign clouds." is awkward and repeats
"for"; replace it with a clearer phrasing such as "Discover the Open Component
Model (OCM) — a model and toolkit for secure delivery in sovereign clouds." to
fix grammar and improve flow.
---
Nitpick comments:
In `@assets/scss/common/_components.scss`:
- Around line 115-117: The summary rule currently hard-codes font-size: 0.95rem
in the .docs-content details summary selector; replace the fixed value with
font-size: inherit so the <summary> inherits surrounding document typography and
stays consistent when base sizes change (update the .docs-content details
summary declaration to remove 0.95rem and use inherit).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cc3f2284-32f5-4c31-93dc-261d4c795a36
📒 Files selected for processing (8)
.github/config/wordlist.txt.gitignoreassets/scss/common/_components.scsscontent/docs/concepts/_index.mdcontent/docs/getting-started/_index.mdcontent/docs/how-to/_index.mdcontent/docs/overview/_index.mdcontent/docs/tutorials/_index.md
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
jakobmoellerdev
approved these changes
Mar 5, 2026
ocmbot Bot
pushed a commit
that referenced
this pull request
Mar 5, 2026
On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> <!-- markdownlint-disable MD041 --> #### What this PR does / why we need it Add content to all section overview pages, that one can reach from the central docs page: https://deploy-preview-734--open-component-model.netlify.app/dev/docs/ Adopt the CSS so that the text in the details/summary section is aligned with the other text on the page (currently it is shown larger as the rest). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Expanded Concepts, Getting Started, How-to, Overview, and Tutorials sections with improved descriptions, prerequisites, and structured learning paths. * Updated Getting Started sidebar navigation. * **Style** * Enhanced styling for details and summary elements in documentation. * **Chores** * Updated configuration files. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> a7fb3a4
This was referenced Mar 9, 2026
Merged
This was referenced Mar 18, 2026
7 tasks
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com
What this PR does / why we need it
Add content to all section overview pages, that one can reach from the central docs page: https://deploy-preview-734--open-component-model.netlify.app/dev/docs/
Adopt the CSS so that the text in the details/summary section is aligned with the other text on the page (currently it is shown larger as the rest).
Summary by CodeRabbit
Documentation
Style
Chores