Draft
Conversation
Contributor
SummaryThe following content is AI-generated and provides a summary of the pull request: Improve and Restructure README DocumentationDocumentation📝 Comprehensive overhaul of the Changes
PR Bot InformationVersion:
💌 Have ideas or want to contribute? Create an issue and share your thoughts with us! Made with ❤️ by Hyperspace. |
![hyperspace-insights[bot]](https://avatars.githubusercontent.com/u/2531208?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
The README is a significant improvement overall, but there are four concrete defects that need fixing: a wrong npm command (npm run add → npm add), a broken CLI flag (-2 → --to), a syntactically invalid TypeScript code snippet in the generic ProcessService usage example, and a missing --no-copy flag in the remote import command that directly contradicts the warning text that follows it.
PR Bot Information
Version: 1.19.1 | 📖 Documentation | 🚨 Create Incident | 💬 Feedback
- Event Trigger:
pull_request.opened - LLM:
anthropic--claude-4.6-sonnet - Correlation ID:
0d7b6410-26c1-11f1-8295-4ba65a303c23
tilwbr
reviewed
Mar 23, 2026
README.md
Outdated
Contributor
There was a problem hiding this comment.
do we still check this? should be removed I guess?
README.md
Outdated
| ``` | ||
|
|
||
| Valid status values are: `RUNNING`, `SUSPENDED`, `CANCELED`, `ERRONEOUS`, `COMPLETED`. | ||
| If no status filter is provided, all statuses except `CANCELED` are returned. |
README.md
Outdated
| - The typed process service does not currently support local development. | ||
| - The process import is currently only possible via the command line. | ||
|
|
||
| # CAP - Process Plugin |
Kronprinz03
commented
Mar 24, 2026
README.md
Outdated
| ``` | ||
| npm install | ||
| npm i -g tsx | ||
| npm run i |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| npm run i | |
| npm i |
Kronprinz03
commented
Mar 24, 2026
README.md
Outdated
Comment on lines
+38
to
+41
| `npm run clean:all` cleans all generated files and rebuilds them | ||
| `npm run clean:build` cleans the build files and rebuilds them | ||
| `npm run clean:types` cleans the generated cds-typer files and rebuilds them | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Suggested change
| `npm run clean:all` cleans all generated files and rebuilds them | |
| `npm run clean:build` cleans the build files and rebuilds them | |
| `npm run clean:types` cleans the generated cds-typer files and rebuilds them | |
| - `npm run clean:all` cleans all generated files and rebuilds them | |
| - `npm run clean:build` cleans the build files and rebuilds them | |
| - `npm run clean:types` cleans the generated cds-typer files and rebuilds them | |
Kronprinz03
commented
Mar 24, 2026
README.md
Outdated
Comment on lines
+31
to
+33
| npm run compile | ||
| cd tests/bookshop && npm run build | ||
| cd tests/bookshop && cds watch |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| npm run compile | |
| cd tests/bookshop && npm run build | |
| cd tests/bookshop && cds watch | |
| npm run compile | |
| cd tests/bookshop | |
| npm run build | |
| cds watch |
Kronprinz03
commented
Mar 24, 2026
Kronprinz03
commented
Mar 24, 2026
README.md
Outdated
| ``` | ||
|
|
||
| If you want to have it as a cds instead of a csn you can add --as cds at the end. If you want to reimport the process use the --force flag at the end. The flag `no-copy` is very important, as otherwise the process will be saved locally on both `./workflows`and `./srv/external` folder which would result in cds runtime issues, as the json is not a valid csn model and cannot be stored in the `.srv/external` directory. | ||
| If you want the output as CDS instead of CSN, you can add `--as cds` at the end. To reimport the process, use the `--force` flag. The `--no-copy` flag is important, as otherwise the process definition will be saved to both `./workflows` and `./srv/external`, which would cause CDS runtime issues since the JSON is not a valid CSN model and cannot be stored in the `./srv/external` directory. |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| If you want the output as CDS instead of CSN, you can add `--as cds` at the end. To reimport the process, use the `--force` flag. The `--no-copy` flag is important, as otherwise the process definition will be saved to both `./workflows` and `./srv/external`, which would cause CDS runtime issues since the JSON is not a valid CSN model and cannot be stored in the `./srv/external` directory. |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Have you...