Skip to content

docs: documentation refresh#14160

Open
MariaIDineva wants to merge 9 commits intomainfrom
docs/documentation-refresh
Open

docs: documentation refresh#14160
MariaIDineva wants to merge 9 commits intomainfrom
docs/documentation-refresh

Conversation

@MariaIDineva
Copy link
Copy Markdown
Contributor

@MariaIDineva MariaIDineva commented Apr 28, 2026

Related Issue(s)

closes #14157

Description

README.md

  • Removed:

    • The MCP Server section that appeared early (between Core Libraries and UI5 Web Components) — it was a duplicate that also used absolute GitHub URLs and an outdated ## 2. Requirements anchor. Removed entirely since the section now lives further down.
    • The old minimal Getting Started section, which was missing the ng new step (it only had ng add), listed Yarn as a requirement (wrong for end-users), and lacked TypeScript in requirements.
  • Added/rewritten:

    • Full Getting Started section: Requirements (Angular 21+, TypeScript 5.9+, Node LTS), peer deps table, and a proper Installation flow.
    • Angular CLI install step before ng new.
    • ng new my-app without the redundant --standalone flag.
    • Complete manual install instructions (styles, assets, providers).
    • A Hello World section with three accurate code snippets matching what Angular CLI actually generates today (app.ts / App, full app.config.ts with provideBrowserGlobalErrorListeners and provideAnimations).
  • Fixed the NEW_COMPONENT.md contributing link (file now exists)

NEW_COMPONENT.md

  • Full contributor guide: library selection table, generator invocation, what gets generated, component patterns, i18n, tests, docs examples, validation, commit format

libs/docs/GETTING_STARTED.md (Home Page)

  • Packages table — split the flat single table into grouped sections: Core Libraries, UI5 Web Components, Supporting Packages, Domain-Specific, and Developer Tooling. Added missing packages (datetime-adapter, moment-adapter, mcp, nx-plugin) and linked each package name to its library folder.
  • Requirements — added TypeScript 5.9+ and a peer dependencies table showing what ng add installs automatically.
  • Quick Start / Installation — expanded significantly:
    • Added Angular CLI install and ng new steps
    • Explained what ng add does automatically (stylesheet, theming assets, providers)
    • Added a manual install section with exact angular.json styles/assets snippets and provider setup
    • Replaced the short import snippet with a full "Hello World" example spanning main.ts, app.config.ts, and app.ts
    • Removed — the per-package detail sections for Core, Platform, CDK, and UI5 Web Components (the Hello World example covers the essentials more concisely). Also removed the "Adding Documentation for a New Component" contributor section which is part of NEW_COMPONENT.md.
    • Running the Docs App — moved up to a more prominent position.
  • Contributing — updated links to point to CONTRIBUTING.md and NEW_COMPONENT.md.
  • Added a ## License section linking to LICENSE.txt.
  • Resources moved to the bottom.

libs/datetime-adapter/README.md

  • Added accurate DayjsDatetimeAdapterModule usage in app.config.ts and in a standalone component
  • Added locale setup and DAYJS_DATE_TIME_ADAPTER_OPTIONS configuration examples
  • Removed the fictional provideDatetimeAdapter() that didn't exist

libs/moment-adapter/README.md

  • Added MomentDatetimeAdapterModule usage examples with deprecation context
  • Added an explicit migration path to datetime-adapter

libs/ui5-webcomponents-base/README.md

  • Fixed wrong import (@ui5/webcomponents-base → @fundamental-ngx/ui5-webcomponents-base)
  • Added UI5WrapperCustomEvent<T, N> usage example
  • Added correct provideUi5LanguageBridge() example (verified from source)

libs/nx-plugin/README.md

  • Added concrete nx g invocations for sap-component with examples
  • Added executor invocation examples for each executor
  • Noted the plugin is monorepo-internal
  • Replaced a misleading nx build webc-generator && nx run webc-generator:generate command which said it would regenerate the wrappers but would only actually regenerate webcomponents-ai package and would exit with an error. No we have the correct command in place - nx build webc-generator && nx run-many -t generate -p ui5-webcomponents ui5-webcomponents-fiori ui5-webcomponents-ai.
  • Removed the generate target in webc-generator/project.json that was used in the misleading command mentioned above.

libs/webc-generator/README.md

  • Added description of the CEM → Angular wrapper pipeline
  • Added workflow for modifying generated behavior and adding new wrappers

Some bugfixes:

  • sap-component generator — add-entry-to-api-files.ts
    api-files.ts uses as const, which SWC wraps in a TsConstAssertion node rather than a plain ObjectExpression. The code assumed .init was directly an ObjectExpression, so .properties was undefined. Fixed by unwrapping TsConstAssertion.expression before accessing .properties.

  • sap-component generator — add-entry-to-docs-routes.ts
    SWC 1.5.7 added a required phase field to Import AST nodes (dynamic import() expressions). The manually-constructed AST was missing phase: 'evaluation', causing printSync to fail with missing field 'phase'.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 28, 2026

Deploy Preview for fundamental-ngx ready!

Name Link
🔨 Latest commit 942f2ab
🔍 Latest deploy log https://app.netlify.com/projects/fundamental-ngx/deploys/69f842ac6aa2a7000923aa15
😎 Deploy Preview https://deploy-preview-14160--fundamental-ngx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@MariaIDineva MariaIDineva changed the title Docs/documentation refresh [WIP] docs: documentation refresh Apr 28, 2026
@droshev droshev added this to the Sprint 157 - April 2026 milestone Apr 28, 2026
@MariaIDineva MariaIDineva changed the title [WIP] docs: documentation refresh docs: documentation refresh Apr 29, 2026
@MariaIDineva MariaIDineva self-assigned this Apr 29, 2026
@MariaIDineva MariaIDineva added the documentation There is an issue with documentation label Apr 29, 2026
@MariaIDineva MariaIDineva requested a review from a team April 29, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation There is an issue with documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation refresh: fix README, update per-library docs, add getting-started examples

2 participants