Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: address DX test feedback for Hilla 2.4 #2970

Merged
merged 5 commits into from
Nov 15, 2023

Conversation

sissbruecker
Copy link
Contributor

Addresses some smaller issues that came up in DX tests.

@github-actions github-actions bot added the Language unchecked English language and AsciiDoc formatting checks haven't been done label Nov 15, 2023
@@ -40,7 +40,12 @@ include::{root}/src/main/java/com/vaadin/demo/fusion/crud/EmployeeRepository.jav

Hilla generates TypeScript objects for each `@BrowserCallable` service implementing the `CrudService<T, ID>` interface. These TypeScript objects have callable methods that execute the corresponding Java service methods, enabling the Add, Update, and Delete operations as well as lazy data loading with sorting and filtering.

For the `EmployeeService` example, you can import the generated TypeScript object in your React view, and use it as a value for the `<AutoForm service={EmployeeService} />` property to render the form.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some testers referred to the example code in this paragraph when creating the initial component, and also missed to expand the code snippet in the example below. They were then confused why they ended up with a partially configured component and had compiler errors. Changed this in both articles to show a proper code snippet with a fully configured component.

@@ -115,7 +115,7 @@ export default function ProductDetailView() {
const { productId } = useParams();

// Fetch product details for the given ID
const { product, setProduct } = useState<Product>();
const [ product, setProduct ] = useState<Product>();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only semi-related, but discovered this syntax issue as part of the tests.

@sissbruecker sissbruecker requested a review from taefi November 15, 2023 14:06
@sissbruecker sissbruecker removed the Language unchecked English language and AsciiDoc formatting checks haven't been done label Nov 15, 2023
@sissbruecker sissbruecker merged commit d906461 into hilla Nov 15, 2023
@sissbruecker sissbruecker deleted the docs/hilla-dx-test-feedback branch November 15, 2023 17:26
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