Skip to content

Commit 01bcfac

Browse files
feat: Moved documentation to portal (#383)
* feat: Added documentation page link to PR template * Removed docs, fixed links * Public docs URL
1 parent 0a6f430 commit 01bcfac

File tree

13 files changed

+22
-1533
lines changed

13 files changed

+22
-1533
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ Please provide a short description of what your change does and why it is needed
1616
- [ ] Tests cover the scope above
1717
- [ ] Error handling created / updated & covered by the tests above
1818
- [ ] ~Aligned changes with the JavaScript SDK~
19-
- [ ] Documentation updated
19+
- [ ] [Documentation](https://github.com/SAP/ai-sdk/tree/main/docs-java) updated
2020
- [ ] Release notes updated

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To use the SDK in a Java application, it is necessary to understand the technica
3535
- Java 17 or higher.
3636
- Access to an **SAP AI Core Service** instance.
3737

38-
Please refer to [this documentation on **how to connect the SDK to AI Core**](docs/guides/CONNECTING_TO_AICORE.md).
38+
Please refer to [this documentation on **how to connect the SDK to AI Core**](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core).
3939

4040
The following table lists the required versions, based on the latest release:
4141

@@ -119,26 +119,26 @@ export AICORE_SERVICE_KEY='{ "clientid": "...", "clientsecret": "...", "url": ".
119119
mvn spring-boot:run
120120
```
121121

122-
Please find **detailed instructions** and more examples [in this documentation](docs/guides/CONNECTING_TO_AICORE.md#using-the-aicore_service_key-environment-variable).
122+
Please find **detailed instructions** and more examples [in this documentation](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core#using-the-aicore_service_key-environment-variable).
123123

124124
### Explore Further Capabilities
125125

126126
Check out the options available for the `OrchestrationPrompt` and `OrchestrationModuleConfig` classes.
127127
You can use templating, content filtering, data masking and more.
128-
Please refer to [this documentation](docs/guides/ORCHESTRATION_CHAT_COMPLETION.md) for more information.
128+
Please refer to [this documentation](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion) for more information.
129129

130130
## Documentation
131131

132132
For more detailed information and advanced usage, please refer to the following:
133133

134-
- [<img src="sample-code/spring-app/src/main/resources/static/BTP-Cockpit-Logo.png"/> Connecting to AI Core](docs/guides/CONNECTING_TO_AICORE.md)
135-
- [<img src="sample-code/spring-app/src/main/resources/static/Orchestration-Logo.png" width="16"/> Orchestration Chat Completion](docs/guides/ORCHESTRATION_CHAT_COMPLETION.md)
136-
- [<img src="sample-code/spring-app/src/main/resources/static/Open-AI-Logo.svg" width="16"/> OpenAI Chat Completion](docs/guides/OPENAI_CHAT_COMPLETION.md)
137-
- [<img src="https://spring.io/favicon-32x32.png" width="16"/> Spring AI Integration](docs/guides/SPRING_AI_INTEGRATION.md)
138-
- [🧰 AI Core Deployment](docs/guides/AI_CORE_DEPLOYMENT.md)
139-
- [<img src="sample-code/spring-app/src/main/resources/static/grounding.png" width="16"/> AI Core Grounding](docs/guides/GROUNDING.md)
134+
- [<img src="sample-code/spring-app/src/main/resources/static/BTP-Cockpit-Logo.png"/> Connecting to AI Core](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core)
135+
- [<img src="sample-code/spring-app/src/main/resources/static/Orchestration-Logo.png" width="16"/> Orchestration Chat Completion](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion)
136+
- [<img src="sample-code/spring-app/src/main/resources/static/Open-AI-Logo.svg" width="16"/> OpenAI Chat Completion](https://sap.github.io/ai-sdk/docs/java/guides/openai-chat-completion)
137+
- [<img src="https://spring.io/favicon-32x32.png" width="16"/> Spring AI Integration](https://sap.github.io/ai-sdk/docs/java/guides/spring-ai-integration)
138+
- [🧰 AI Core Deployment](https://sap.github.io/ai-sdk/docs/java/guides/ai-core-deployment)
139+
- [<img src="sample-code/spring-app/src/main/resources/static/grounding.png" width="16"/> AI Core Grounding](https://sap.github.io/ai-sdk/docs/java/guides/document-grounding)
140140

141-
For updating versions, please refer to the [**Release Notes**](docs/release-notes/release-notes-0-to-14.md).
141+
For updating versions, please refer to the [**Release Notes**](https://sap.github.io/ai-sdk/docs/java/release-notes).
142142

143143
## Build the Project
144144

@@ -177,7 +177,7 @@ OrchestrationClient client = new OrchestrationClient(destination);
177177
OpenAiClient client2 = OpenAiClient.withCustomDestination(destination);
178178
```
179179

180-
For more information, please refer to the [AI Core connectivity guide](./docs/guides/CONNECTING_TO_AICORE.md) and the [SAP Cloud SDK documentation](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations).
180+
For more information, please refer to the [AI Core connectivity guide](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core) and the [SAP Cloud SDK documentation](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations).
181181

182182
### _"There's a vulnerability warning `CVE-2021-41251`?"_
183183

docs/blog/Introducing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ String id = deployment.getId();
4141
AiExecutionStatus status = deployment.getStatus();
4242
```
4343

44-
You can learn more about the SDK's capabilities for SAP AI Core [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/AI_CORE_DEPLOYMENT.md).
44+
You can learn more about the SDK's capabilities for SAP AI Core [in this guide](https://sap.github.io/ai-sdk/docs/java/guides/ai-core-deployment).
4545

4646
## AI Core - Orchestration
4747

@@ -72,7 +72,7 @@ var result = client.chatCompletion(prompt, config);
7272
String messageResult = result.getContent();
7373
```
7474

75-
You can learn more about the SDK's capabilities for Orchestration Service [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/ORCHESTRATION_CHAT_COMPLETION.md).
75+
You can learn more about the SDK's capabilities for Orchestration Service [in this guide](https://sap.github.io/ai-sdk/docs/java/guides/orchestration-chat-completion).
7676

7777
## AI Core - Foundation Models
7878

@@ -101,7 +101,7 @@ var result =
101101
String resultMessage = result.getContent();
102102
```
103103

104-
You can learn more about the SDK's capabilities for foundation models and OpenAI specific features [in the public repository guide](https://github.com/SAP/ai-sdk-java/blob/main/docs/guides/OPENAI_CHAT_COMPLETION.md).
104+
You can learn more about the SDK's capabilities for foundation models and OpenAI specific features [this guide](https://sap.github.io/ai-sdk/docs/java/guides/openai-chat-completion).
105105

106106
## Getting Started
107107

docs/guides/AI_CORE_DEPLOYMENT.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

docs/guides/CONNECTING_TO_AICORE.md

Lines changed: 0 additions & 175 deletions
This file was deleted.

0 commit comments

Comments
 (0)