Skip to content

Commit fd5f1a3

Browse files
authored
fix: docs hyperlinks (#28)
1 parent d62e716 commit fd5f1a3

4 files changed

Lines changed: 11 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ For contributing bug fixes or implementing approved features:
6767

6868
Before starting your contribution:
6969
- **Examine existing modules** in the `src/sap_cloud_sdk/` directory (e.g., `auditlog`, `objectstore`, `destination`) to understand implementation patterns
70-
- **Read [Code Guidelines](./GUIDELINES.md)** to understand our development standards and conventions
70+
- **Read [Code Guidelines](docs/GUIDELINES.md)** to understand our development standards and conventions
7171
- **Review existing user guides** to understand the expected documentation format and API patterns
7272

7373
### 2. Create or claim an issue
@@ -105,7 +105,7 @@ Once your proposal receives the `approved` label, you can begin implementation:
105105

106106
**Implementation Requirements:**
107107

108-
Follow our [Code Guidelines](./GUIDELINES.md) when implementing your changes. For bug fixes:
108+
Follow our [Code Guidelines](docs/GUIDELINES.md) when implementing your changes. For bug fixes:
109109
- Identify the root cause of the issue
110110
- Implement the fix with minimal changes
111111
- Add or update tests to prevent regression
@@ -188,7 +188,7 @@ In particular:
188188

189189
## Consult Documentation
190190

191-
Please consult our [documentation](../docs) to understand the project structure and conventions.
191+
Please consult our [documentation](docs/) to understand the project structure and conventions.
192192

193193
## Current Maintainers
194194

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ The Python SDK offers a clean, type-safe API following Python best practices whi
88

99
## Available Modules
1010

11-
- [AuditLog User Guide](../src/sap_cloud_sdk/core/auditlog/user-guide.md) - Compliance audit logging for SAP Audit Log Service
12-
- [Destination User Guide](../src/sap_cloud_sdk/destination/user-guide.md) - SAP BTP Destination Service integration with proxy support
13-
- [ObjectStore User Guide](../src/sap_cloud_sdk/objectstore/user-guide.md) - S3-compatible object storage
14-
- [Secret Resolver User Guide](../src/sap_cloud_sdk/core/secret_resolver/user-guide.md) - Secure credential management from mounted volumes and environment variables
15-
- [Telemetry User Guide](../src/sap_cloud_sdk/core/telemetry/user-guide.md) - OpenTelemetry tracing and GenAI auto-instrumentation
11+
- [AuditLog User Guide](src/sap_cloud_sdk/core/auditlog/user-guide.md) - Compliance audit logging for SAP Audit Log Service
12+
- [Destination User Guide](src/sap_cloud_sdk/destination/user-guide.md) - SAP BTP Destination Service integration with proxy support
13+
- [ObjectStore User Guide](src/sap_cloud_sdk/objectstore/user-guide.md) - S3-compatible object storage
14+
- [Secret Resolver User Guide](src/sap_cloud_sdk/core/secret_resolver/user-guide.md) - Secure credential management from mounted volumes and environment variables
15+
- [Telemetry User Guide](src/sap_cloud_sdk/core/telemetry/user-guide.md) - OpenTelemetry tracing and GenAI auto-instrumentation
1616

1717
---
1818

@@ -101,7 +101,7 @@ export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel-collector.example.com"
101101
```python
102102
from sap_cloud_sdk.core.auditlog import (create_client, SecurityEvent)
103103

104-
# Create client )
104+
# Create audit log client
105105
client = create_client()
106106

107107
# Security event - authentication attempt

docs/DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ uv run pytest --cov=src
7070
For the end-to-end process to cut a release and publish artifacts, see the [Release and Deployment Guide](RELEASE.md).:
7171

7272
## Contributing
73-
For guidance on contributing with new features, see the [Contributing Guide](CONTRIBUTING.md).
73+
For guidance on contributing with new features, see the [Contributing Guide](../CONTRIBUTING.md).

src/sap_cloud_sdk/objectstore/user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ uv add sap-cloud-sdk
1414
pip install sap-cloud-sdk
1515
```
1616

17-
See further information about installation in the [main documentation](/docs/README.md#installation).
17+
See further information about installation in the [main documentation](/README.md#installation).
1818

1919
## Import
2020

0 commit comments

Comments
 (0)