Skip to content

Conversation

@w1am
Copy link
Contributor

@w1am w1am commented Dec 12, 2025

User description

Description

Page previews


PR Type

Enhancement


Description

  • Add .NET SDK v1.3 and v1.2 release branches to documentation

  • Add Python SDK v1.2 and v1.1 release branches to documentation

  • Update Python SDK v1.0 branch naming convention


Diagram Walkthrough

flowchart LR
  repos["repos.json"] -- "Add .NET v1.3, v1.2 branches" --> dotnet["dotnet-client config"]
  repos -- "Add Python v1.2, v1.1 branches" --> python["python-client config"]
  repos -- "Update Python v1.0 branch name" --> python
Loading

File Walkthrough

Relevant files
Configuration changes
repos.json
Add multiple SDK version branches to documentation config

import/repos.json

  • Add v1.3 and v1.2 release branches for .NET SDK with getting-started
    start pages
  • Add v1.2 and v1.1 release branches for Python SDK with getting-started
    start pages
  • Update Python SDK v1.0 branch name from docs/v1.0 to v1.0
+21/-1   

@w1am w1am requested a review from a team as a code owner December 12, 2025 13:05
@github-actions
Copy link

github-actions bot commented Dec 12, 2025

Docs build

@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Dec 12, 2025

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Non-applicable Scope: The changes are static documentation configuration entries and do not implement or modify
runtime actions that would require audit logging, so applicability cannot be determined
from this diff.

Referred Code
{
  "version": "v1.3",
  "name": "release/v1.3",
  "startPage": "getting-started"
},
{
  "version": "v1.2",
  "name": "release/v1.2",
  "startPage": "getting-started"
},
{
  "version": "v1.1",
  "name": "release/v1.1",
  "startPage": "getting-started"
},
{
  "version": "v1.0",
  "name": "release/v1.0",
  "startPage": "getting-started"
},
{


 ... (clipped 138 lines)

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Config Only Change: The diff only adds JSON configuration entries without executable logic, so error handling
and edge case management cannot be evaluated from this change.

Referred Code
{
  "version": "v1.3",
  "name": "release/v1.3",
  "startPage": "getting-started"
},
{
  "version": "v1.2",
  "name": "release/v1.2",
  "startPage": "getting-started"
},
{
  "version": "v1.1",
  "name": "release/v1.1",
  "startPage": "getting-started"
},
{
  "version": "v1.0",
  "name": "release/v1.0",
  "startPage": "getting-started"
},
{


 ... (clipped 138 lines)

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status:
External Inputs Undefined: The change updates repository and branch metadata in JSON; without seeing the consuming
code paths, we cannot verify input validation, sanitization, or authorization of this
external configuration.

Referred Code
{
  "version": "v1.3",
  "name": "release/v1.3",
  "startPage": "getting-started"
},
{
  "version": "v1.2",
  "name": "release/v1.2",
  "startPage": "getting-started"
},
{
  "version": "v1.1",
  "name": "release/v1.1",
  "startPage": "getting-started"
},
{
  "version": "v1.0",
  "name": "release/v1.0",
  "startPage": "getting-started"
},
{


 ... (clipped 138 lines)

Learn more about managing compliance generic rules or creating your own custom rules

  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@github-actions
Copy link

Docs build

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 12, 2025

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 26faa6a
Status: ✅  Deploy successful!
Preview URL: https://dfda70e7.documentation-21k.pages.dev
Branch Preview URL: https://w1am-import-client-docs.documentation-21k.pages.dev

View logs

@qodo-code-review
Copy link
Contributor

qodo-code-review bot commented Dec 12, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Correct non-existent default branch name

Update the currentBranch for the pyeventsourcing/kurrentdbclient repository from
main to master to match the repository's actual default branch.

import/repos.json [219-236]

+"repo": "https://github.com/pyeventsourcing/kurrentdbclient",
+"branches": [
+  {
+    "version": "v1.2",
+    "name": "v1.2",
+    "startPage": "getting-started"
+  },
+  {
+    "version": "v1.1",
+    "name": "v1.1",
+    "startPage": "getting-started"
+  },
+  {
+    "version": "v1.0",
+    "name": "v1.0",
+    "startPage": "getting-started"
+  }
+]
 
-
  • Apply / Chat
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies that the currentBranch for the kurrentdbclient repository is set to main, while the actual default branch is master, which would likely cause a functional bug in any tooling using this configuration.

Medium
Organization
best practice
Add redirects for moved docs

Because branch names and start pages changed (e.g., docs/v1.0 → v1.0), add
redirects and update any inbound links that referenced old paths to avoid 404s.

import/repos.json [221-235]

 {
   "version": "v1.2",
   "name": "v1.2",
-  "startPage": "getting-started"
+  "startPage": "getting-started",
+  "redirects": [{ "from": "/python/docs/v1.2/index.html", "to": "/python/v1.2/getting-started/" }]
 },
 {
   "version": "v1.1",
   "name": "v1.1",
-  "startPage": "getting-started"
+  "startPage": "getting-started",
+  "redirects": [{ "from": "/python/docs/v1.1/index.html", "to": "/python/v1.1/getting-started/" }]
 },
 {
   "version": "v1.0",
   "name": "v1.0",
-  "startPage": "getting-started"
+  "startPage": "getting-started",
+  "redirects": [{ "from": "/python/docs/v1.0/index.html", "to": "/python/v1.0/getting-started/" }, { "from": "/python/docs/v1.0/", "to": "/python/v1.0/" }]
 }
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why:
Relevant best practice - When restructuring navigation or moving/removing pages, add redirects and update inbound links to prevent 404s.

Low
Add explicit versioned doc conventions

Verify that the new v1.2/v1.3 docs use KurrentDB naming and updated connection
strings (kurrentdb://, kurrentdb+discover://), while older branches keep legacy
EventStoreDB/esdb wording as needed.

import/repos.json [76-85]

 {
   "version": "v1.3",
   "name": "release/v1.3",
-  "startPage": "getting-started"
+  "startPage": "getting-started",
+  "docConventions": { "product": "KurrentDB", "schemes": ["kurrentdb://", "kurrentdb+discover://"] }
 },
 {
   "version": "v1.2",
   "name": "release/v1.2",
-  "startPage": "getting-started"
+  "startPage": "getting-started",
+  "docConventions": { "product": "KurrentDB", "schemes": ["kurrentdb://", "kurrentdb+discover://"] }
 }

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 5

__

Why:
Relevant best practice - Ensure version-specific documentation uses correct, version-appropriate product names and connection details.

Low
  • Update

@w1am w1am force-pushed the w1am/import-client-docs branch from 57e651c to 26faa6a Compare December 12, 2025 13:07
@w1am w1am requested a review from alexeyzimarev December 12, 2025 13:13
@alexeyzimarev alexeyzimarev merged commit a42ed4c into master Dec 12, 2025
3 checks passed
@alexeyzimarev alexeyzimarev deleted the w1am/import-client-docs branch December 12, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants