Skip to content

docs: improve documentation#13

Open
dahlinomine wants to merge 1 commit intoSergePauli:mainfrom
dahlinomine:docs/improve-readme-1774602413
Open

docs: improve documentation#13
dahlinomine wants to merge 1 commit intoSergePauli:mainfrom
dahlinomine:docs/improve-readme-1774602413

Conversation

@dahlinomine
Copy link
Copy Markdown

Summary

This PR improves the README documentation for this project.

Changes: Improve documentation


This contribution was made as part of an open-source documentation improvement initiative. All changes are meant to be helpful additions to the project.

@dahlinomine dahlinomine requested a review from SergePauli as a code owner March 27, 2026 09:06
@SergePauli
Copy link
Copy Markdown
Owner

Thanks for the contribution.

I’m okay with the added lines, but I don’t want to remove the existing README sections.
The deleted parts currently document important engine behavior: formatters/localization, relations, filtering/sorting/pagination, and API request/response examples.

Please update this PR so it keeps the existing documentation and only adds the new clarifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants