Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor docs #92

Merged
merged 15 commits into from
Oct 11, 2024
Merged

Refactor docs #92

merged 15 commits into from
Oct 11, 2024

Conversation

rpanackal
Copy link
Member

@rpanackal rpanackal commented Oct 8, 2024 •
edited
Loading

Context

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

Improve documentation for readability.

Feature scope:

  • Split content into multiple .md files by modules
  • Add a quickstart and table of contents
  • Reduce redundancy eg requirements list
  • Move contribution instruction to Contribution Guide

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

@rpanackal rpanackal assigned rpanackal and newtork and unassigned rpanackal Oct 8, 2024
@rpanackal rpanackal assigned rpanackal and unassigned newtork Oct 8, 2024
@rpanackal rpanackal requested a review from newtork October 8, 2024 15:44
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
newtork
newtork reviewed Oct 9, 2024
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@rpanackal rpanackal merged commit b98b503 into main Oct 11, 2024
5 checks passed
@rpanackal rpanackal deleted the refactor-docs branch October 11, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@newtork newtork newtork approved these changes

Assignees

@rpanackal rpanackal

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rpanackal @newtork @a-d