Skip to content

Conversation

@CharlesDuboisSAP
Copy link
Contributor

@CharlesDuboisSAP CharlesDuboisSAP commented Mar 12, 2025

Context

AI/ai-sdk-java-backlog#218.

We moved the documentation from here to the documentation portal

Feature scope:

  • Delete documentation
    • Fix links in this repo
    • Fix links in GitHub releases
  • Add link to template

Definition of Done

  • Functionality scope stated & covered
  • Tests cover the scope above
  • Error handling created / updated & covered by the tests above
  • Aligned changes with the JavaScript SDK
  • Documentation updated
  • Release notes updated

@CharlesDuboisSAP CharlesDuboisSAP self-assigned this Mar 12, 2025
@CharlesDuboisSAP CharlesDuboisSAP changed the title feat: Added documentation page link to PR template feat: Moved documentation to portal Mar 12, 2025
Copy link
Contributor

@TillK17 TillK17 left a comment

Choose a reason for hiding this comment

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

LGTM, have obviously not checked the whole content of the new documentation platform though.

Copy link
Contributor

@TillK17 TillK17 Mar 12, 2025

Choose a reason for hiding this comment

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

The GitHub Releases arent dependent this markdown, right?

Copy link
Member

Choose a reason for hiding this comment

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

As far as I understand, it depends on docs/release-notes/release_notes.md, which is fine.

Jonas-Isr
Jonas-Isr previously approved these changes Mar 12, 2025
Copy link
Member

@Jonas-Isr Jonas-Isr left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@Jonas-Isr Jonas-Isr left a comment

Choose a reason for hiding this comment

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

After thinking about it, do we not have to change the python script release_notes_automation here to not create the release-notes-X-to-Y in this repo again? Or will that be handled in a separate PR?

@Jonas-Isr Jonas-Isr dismissed their stale review March 12, 2025 15:05

see comment

@CharlesDuboisSAP CharlesDuboisSAP merged commit 01bcfac into main Mar 12, 2025
8 checks passed
@CharlesDuboisSAP CharlesDuboisSAP deleted the CharlesDuboisSAP-patch-1 branch March 12, 2025 15:21
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.

4 participants