Skip to content

Commit 97f19cf

Browse files
marianfooclaude
andcommitted
docs: move the UI5 docs into the combined repo + finish the ABAP section
Migrates the full ui5-cc-spreadsheetimporter MkDocs documentation into this repo under docs/ui5/ (index, all pages, images, stylesheets, overrides), preserving every relative link/asset, and merges it with the ABAP backend section into one MkDocs Material site: - one combined nav: Home + UI5 Component (Frontend) + ABAP Importer (Backend) - the UI5 theme reused for both (custom SAP-blue/Excel-green palette, logo, overrides, minify, full pymdownx extension set) - CNAME (docs.spreadsheet-importer.com) carried over for the deploy step - fixed a pre-existing broken relative link in the UI5 Pro install page - the ABAP docs are self-contained: inline code snippets, no links into the (private) ABAP repos Builds clean with 'mkdocs build --strict' (37 pages). Publishing to docs.spreadsheet-importer.com is the next step. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3961fd4 commit 97f19cf

53 files changed

Lines changed: 6646 additions & 47 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.spreadsheet-importer.com

docs/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,5 @@ can keep small imports in the browser and offload large ones to ABAP.
4343
[Integration Guide](abap/integration-guide.md).
4444
- **Extending the import?** See [Extension hooks](abap/integration-guide.md#extension-hooks-zif_ssi_hooks)
4545
(`ZIF_SSI_HOOKS`) and the runnable [Usage Cookbook](abap/usage-cookbook.md).
46-
- **Frontend component?** The full UI5 docs are at
47-
[docs.spreadsheet-importer.com](https://docs.spreadsheet-importer.com/) — see the
48-
[UI5 overview](ui5/index.md) here for the map.
46+
- **Frontend component?** See the [UI5 component docs](ui5/index.md) — getting started,
47+
configuration, events, UPDATE, the CAP CDS plugin, and the full API reference.

docs/llms.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# UI5 Spreadsheet Importer (ui5-cc-spreadsheetimporter)
2+
> UI5 component to import spreadsheet data into Fiori/UI5 apps, supporting bulk Excel uploads and optional CAP backend processing.
3+
4+
**Notes**
5+
- Works with Fiori Elements and freestyle UI5 apps; backend-agnostic; see repo for license.
6+
- For large workbooks, prefer server-side processing with the CAP CDS Plugin.
7+
- Keep `manifest.json` version namespaces aligned with the deployed component.
8+
- Issues & updates: https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues
9+
10+
## Quick Start
11+
- [Getting Started](https://docs.spreadsheet-importer.com/pages/GettingStarted/): Install via npm/CDN, set `resourceRoots` and `componentUsages`.
12+
- [Configuration](https://docs.spreadsheet-importer.com/pages/Configuration/): Reference of options with examples and defaults.
13+
- [API Reference](https://docs.spreadsheet-importer.com/pages/APIReference/): Component methods, events, and constructor options.
14+
15+
## Core Features
16+
- [Button Control](https://docs.spreadsheet-importer.com/pages/Button/): Add the importer button and preload configuration.
17+
- [Events](https://docs.spreadsheet-importer.com/pages/Events/): Extension points for validation and data manipulation.
18+
- [Wizard](https://docs.spreadsheet-importer.com/pages/Wizard/): Guided step-by-step import process (v2.2.0+).
19+
20+
## Deployment & Operations
21+
- [Central Deployment](https://docs.spreadsheet-importer.com/pages/CentralDeployment/): Recommended central deployment to ABAP/BTP systems.
22+
- [Update Operations](https://docs.spreadsheet-importer.com/pages/Update/): Update existing entities instead of creating new ones.
23+
- [Supported Versions](https://docs.spreadsheet-importer.com/pages/SupportVersions/): Compatible UI5 versions and tested scenarios.
24+
25+
## Backend & Advanced
26+
- [CAP CDS Plugin](https://docs.spreadsheet-importer.com/pages/CdsPlugin/): Upload directly to CAP backend for scalability.
27+
- [Troubleshooting](https://docs.spreadsheet-importer.com/pages/Troubleshooting/): Common errors, diagnostics, debug flags.
28+
- [GitHub Repository](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter): Source, releases, issues.
29+
30+
## Optional
31+
- [Checks & Validation](https://docs.spreadsheet-importer.com/pages/Checks/): Built-in data validation and error types.
32+
- [Table Selector](https://docs.spreadsheet-importer.com/pages/TableSelector/): Multi-table selection dialog for complex views.
33+
- [Spreadsheet Download](https://docs.spreadsheet-importer.com/pages/spreadsheetdownload/): Export backend data to spreadsheets.
34+
- [Development Guide](https://docs.spreadsheet-importer.com/pages/Development/GettingStarted/): Local dev setup and sample apps.
35+
- [Package on jsDelivr](https://www.jsdelivr.com/package/npm/ui5-cc-spreadsheetimporter): Public package and latest version.

docs/ui5/images/Logo_square.png

967 KB
Loading
1.26 MB
Loading

docs/ui5/images/Logo_wide.png

737 KB
Loading

docs/ui5/images/Logo_wide_dark.png

630 KB
Loading
330 KB
Loading
54.2 KB
Loading

docs/ui5/images/error_dialog.png

34 KB
Loading

0 commit comments

Comments
 (0)