Skip to content

PB-1750: Remove redundant documentation from examples/README.md#221

Merged
cariad merged 2 commits intomainfrom
PB-1750-cariad-add-docs-about-custom-sdk-env-back-into-sdk-project_extras
Mar 30, 2026
Merged

PB-1750: Remove redundant documentation from examples/README.md#221
cariad merged 2 commits intomainfrom
PB-1750-cariad-add-docs-about-custom-sdk-env-back-into-sdk-project_extras

Conversation

@cariad
Copy link
Copy Markdown
Contributor

@cariad cariad commented Mar 25, 2026

Remove redundant documentation from examples/README.md

Description

examples/README.md currently contains information that's duplicated from the main README.md, and some information that's out of date.

This change:

  1. Makes the main README.md the single source of truth for installation and configuration.
  2. Makes the example notebooks the single source of truth for demonstrating usage.
  3. Adds descriptions of the three optional extras: data, notebook and vis.

Resolves PB-1750.

Docstring & Example Checklist

  • I have added or updated docstrings for all public classes, methods, and functions
  • I have included doctest-style examples in docstrings where appropriate
  • All examples use correct Python prompt formatting (>>>, ... for continuation lines)
  • All code, class, and method names in docstrings are wrapped in backticks (e.g. `Add`)

This comment was marked as outdated.

@cariad cariad marked this pull request as ready for review March 25, 2026 15:05
Copy link
Copy Markdown
Contributor

@eirinikouvara eirinikouvara left a comment

Choose a reason for hiding this comment

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

I love this! Very nice and clear :)

@cariad cariad merged commit 25e8433 into main Mar 30, 2026
14 checks passed
@cariad cariad deleted the PB-1750-cariad-add-docs-about-custom-sdk-env-back-into-sdk-project_extras branch March 30, 2026 09:56
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