Skip to content

Update README files#8

Merged
arman-boyakhchyan merged 9 commits into
25.1.2+from
readme-update
Dec 1, 2025
Merged

Update README files#8
arman-boyakhchyan merged 9 commits into
25.1.2+from
readme-update

Conversation

@arman-boyakhchyan
Copy link
Copy Markdown
Contributor

No description provided.

@arman-boyakhchyan arman-boyakhchyan self-assigned this Nov 24, 2025
Comment thread README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
Comment thread Angular/README.md Outdated
@@ -4,7 +4,7 @@ For more information about this example check the [Readme](../README.md).

## Prerequisite
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We discussed this case with Editorial Insights. "X is a prerequisite for Y" sounds perfectly fine in a sentence, but I feel uncomfortable when it is used as a heading and we have just one item.

I assume (but I didn't check code) that out example is configured so that we expect data at this specific port. We can convert this section into a note and say something like: "In this example, the server uses/runs on/available at port 5005. To change the port, update the following line ".

Alternatively, we can change the heading to "Access the Server" or something similar.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I feel we will miss the point of informing the user that they need to start the OData server before starting the app/dev server. I propose the following modifications to your suggestions:

Suggested change
## Prerequisite
## Access the Server
Start the [ODataServer](../ODataServer) before running the application. This example is configured to access the ODataServer at port 5005. To change this configuration, update the following line: [app.component.ts#L13](/Angular/src/app/app.component.ts#L13)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Good point. It was not obvious in the original version. A minor update:

Suggested change
## Prerequisite
## Start the Server
Start the [ODataServer](../ODataServer) before you run the application. This example is configured to access the ODataServer at port 5005. To change this configuration, update the following line: [app.component.ts#L13](/Angular/src/app/app.component.ts#L13)

Comment thread ODataServer/README.md Outdated
Comment on lines +3 to +7
An [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project that creates OData endpoints.

## Overview

This server exposes product data through OData endpoints, enabling advanced querying capabilities such as filtering, sorting, selecting specific fields, and more through standardized OData query options.
This server creates OData endpoints to expose sample data. You can use standardized OData queries to access data and run filtering, selection, and sorting operations.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please double-check if this is technically accurate.

Suggested change
An [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project that creates OData endpoints.
## Overview
This server exposes product data through OData endpoints, enabling advanced querying capabilities such as filtering, sorting, selecting specific fields, and more through standardized OData query options.
This server creates OData endpoints to expose sample data. You can use standardized OData queries to access data and run filtering, selection, and sorting operations.
The [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) library creates OData endpoints to expose sample data. You can use standardized OData queries to access and filter, select, and sort data.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure it is 100% correct to say that the library itself creates the OData endpoints, I propose the following modifications to your suggesstion:

This [ASP.NET Core OData 8](https://learn.microsoft.com/en-us/odata/webapi-8/overview) project creates OData endpoints to expose sample data. You can use standardized OData queries to access and filter, select, and sort data.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Can we call "ASP.NET Core OData 8" an application or a solution? I was confused at first and had to read Microsoft intro to understand what project is in this context. If no, let's leave your version.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

"ASP.NET Core OData 8" is a library that our app in the ODataServer path uses. Given this is the main library used in this application, yeah we can say "This ASP.NET Core OData 8 application creates..."

Comment thread ODataServer/README.md Outdated
Comment thread README.md Outdated
# DevExtreme DataGrid - Bind to an OData Service

This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. It shows how to configure the ODataStore for server-side data operations including filtering, selecting specific fields, and querying product data.
This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please, clarify what "ODataStore" is. Project? Class? Service?

Suggested change
This example demonstrates how to bind the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting.
This example binds the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It is a service/data store.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
```
The server will be available at `http://localhost:5005`.
1. **Start the OData Server**
Run the following command to start the OData server:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
Run the following command to start the OData server:
Execute the following command to start the OData server:

Comment thread README.md Outdated
Comment on lines +37 to +39

2. **Run the Client Application:**
Run one of the following commands to start the client application:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
2. **Run the Client Application:**
Run one of the following commands to start the client application:
2. **Run the Client Application:**
Run one of the following commands to run the client application:

Comment thread README.md Outdated
dotnet run
```

The server starts at the following URL: `http://localhost:5005`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
The server starts at the following URL: `http://localhost:5005`.
The server is available at the following URL: `http://localhost:5005`.

Comment thread README.md Outdated
```

The application will be available at `http://localhost:59183` .
The application starts at the following URL: `http://localhost:59183` .
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

same here

Comment thread README.md Outdated
This example binds the DevExtreme DataGrid component to an OData v4 service. An ODataStore is configured to run server-side data operations including filtering, selection, and sorting.

## Implementation Overview
## Implementation Steps
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
## Implementation Steps
## Implementation Details

Comment thread README.md Outdated
1. Create an [ODataStore](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/). Use its properties to specify the service's [url](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#url), [key](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#key) data field, and OData [version](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#version).
2. You can configure **ODataStore** as a standalone element (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to demonstrate data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and data fields [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select).
1. Create an [ODataStore](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/). Specify the service [url](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#url), [key](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#key) data field, and OData [version](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/ODataStore/Configuration/#version).
2. You can configure a standalone **ODataStore** (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Since we have an article...

Suggested change
2. You can configure a standalone **ODataStore** (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations.
2. You can configure a standalone **ODataStore** service (see [OData](https://js.devexpress.com/Documentation/Guide/Data_Binding/Specify_a_Data_Source/OData/) for details), but this examples uses a [DataSource](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/) to implement data [filtering](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#filter) and [selection](https://js.devexpress.com/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#select) operations.

@arman-boyakhchyan arman-boyakhchyan merged commit e1b34cd into 25.1.2+ Dec 1, 2025
9 of 11 checks passed
@arman-boyakhchyan arman-boyakhchyan deleted the readme-update branch December 1, 2025 09:52
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.

3 participants