Skip to content

Commit 51bf868

Browse files
committed
Also update docs with official name
1 parent ceb9d0f commit 51bf868

File tree

5 files changed

+12
-19
lines changed

5 files changed

+12
-19
lines changed

spring-grpc-docs/src/main/antora/modules/ROOT/nav.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
* xref:index.adoc[Overview]
2-
* xref:concepts.adoc[Grpc Concepts]
2+
* xref:concepts.adoc[GRPC Concepts]
33
* xref:getting-started.adoc[Getting Started]
44
55
* xref:contribution-guidelines.adoc[Contribution Guidelines]
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
[[concepts]]
2-
= Grpc Concepts
2+
= GRPC Concepts
33

4-
This section describes core concepts that Spring Grpc uses. We recommend reading it closely to understand the ideas behind how Spring Grpc is implemented.
4+
This section describes core concepts that Spring gRPC uses. We recommend reading it closely to understand the ideas behind how Spring gRPC is implemented.

spring-grpc-docs/src/main/antora/modules/ROOT/pages/contribution-guidelines.adoc

+1-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,7 @@ Before submitting a PR, please run the following commands to ensure proper forma
1111

1212
The `-Pjavadoc` is a profile that enables Javadoc processing so as to avoid a long build time when developing.
1313

14-
== Contributing a New Grpc Model Implementation
15-
16-
This section outlines the steps for contributing a new Grpc model implementation.
17-
Grpc models vary significantly, with diverse inputs and outputs -- from chat models that
18-
translate text input into text output, to text-to-image models that generate images
19-
from text descriptions.
20-
Complex models may even handle multiple types of input and output, such as combining text,
21-
images, and videos to produce mixed media output.
14+
== Contributing a New GRPC Features
2215

2316
To contribute a new feature, adhere to the following steps:
2417

spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[[getting-started]]
22
= Getting Started
33

4-
This section offers jumping off points for how to get started using Spring Grpc.
4+
This section offers jumping off points for how to get started using Spring gRPC.
55

66
You should follow the steps in each of the following section according to your needs.
77

8-
NOTE: Spring Grpc supports Spring Boot 3.3.x
8+
NOTE: Spring gRPC supports Spring Boot 3.3.x
99

1010
[[repositories]]
1111
== Add Milestone and Snapshot Repositories
@@ -53,7 +53,7 @@ repositories {
5353
[[dependency-management]]
5454
== Dependency Management
5555

56-
The Spring Grpc Bill of Materials (BOM) declares the recommended versions of all the dependencies used by a given release of Spring Grpc.
56+
The Spring gRPC Bill of Materials (BOM) declares the recommended versions of all the dependencies used by a given release of Spring gRPC.
5757
Using the BOM from your application’s build script avoids the need for you to specify and maintain the dependency versions yourself.
5858
Instead, the version of the BOM you’re using determines the utilized dependency versions.
5959
It also ensures that you’re using supported and tested versions of the dependencies by default, unless you choose to override them.
@@ -75,7 +75,7 @@ If you’re a Maven user, you can use the BOM by adding the following to your po
7575
</dependencyManagement>
7676
----
7777

78-
Gradle users can also use the Spring Grpc BOM by leveraging Gradle (5.0+) native support for declaring dependency constraints using a Maven BOM.
78+
Gradle users can also use the Spring gRPC BOM by leveraging Gradle (5.0+) native support for declaring dependency constraints using a Maven BOM.
7979
This is implemented by adding a 'platform' dependency handler method to the dependencies section of your Gradle build script.
8080
As shown in the snippet below this can then be followed by version-less declarations of the Starter Dependencies for the one or more spring-grpc modules you wish to use, e.g. spring-grpc-openai.
8181

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[[introduction]]
2-
= Spring Grpc
2+
= Spring GRPC
33

4-
The `Spring Grpc` project aims to streamline the development of Grpc applications.
4+
The `Spring gRPC` project aims to streamline the development of gRPC applications.
55

6-
The xref:concepts.adoc[concepts section] provides a high-level overview of Grpc concepts and their representation in Spring Grpc.
6+
The xref:concepts.adoc[concepts section] provides a high-level overview of gRPC concepts and their representation in Spring gRPC.
77

8-
The xref:getting-started.adoc[Getting Started] section shows you how to create your first Grpc application.
8+
The xref:getting-started.adoc[Getting Started] section shows you how to create your first gRPC application.
99
Subsequent sections delve into each component and common use cases with a code-focused approach.

0 commit comments

Comments
 (0)