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.

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

Niko/java doc updates #576

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Niko/java doc updates #576

wants to merge 5 commits into from

Conversation

nikomancy
Copy link
Contributor

What?

Moving the Java docs into the format similar to what we have for node.

Why?

  • The goal is to make the learning journey for engineers working with specific SDKs easier.
  • Content is easier to find in the TOC, improving navigability.
  • Code samples for typed examples have been added for ease of use.
  • Boilerplate prose docs have been added to allow engineers to learn about relevant conceptual information alongside the code without having to context switch to other parts of the docs.

Review instructions

  • Code samples were created quickly based on inferences between existing code samples and other SDKs. There are almost certainly things off about them.
  • Tables need to be validated.

Upon completion of review, this is good to merge.

* Adding intro
* Adding assignment
* Adding initialization
* Adding bandits
Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for eppo-data-docs ready!

Name Link
🔨 Latest commit d760c48
🔍 Latest deploy log https://app.netlify.com/sites/eppo-data-docs/deploys/679872c0983662000924a45c
😎 Deploy Preview https://deploy-preview-576--eppo-data-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@nikomancy nikomancy requested review from aarsilv and typotter January 28, 2025 06:02
Copy link
Collaborator

@typotter typotter left a comment

Choose a reason for hiding this comment

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

Hey Niko,
Thanks for updating the docs!
I left a couple of comments and put up #599 just now for you to review and merge into your docs. Should be good to go after that.

/sdks/server-sdks/java/#assignments /sdks/server-sdks/java/assignments
/sdks/server-sdks/java/#assignment-types /sdks/server-sdks/java/assignments#assignment-types
/sdks/server-sdks/java/#subject-attributes /sdks/server-sdks/java/assignments#subject-attributes
/sdks/server-sdks/java/#assignment-logger /sdks/server-sdks/java/assignments#assignment-logger
Copy link
Collaborator

Choose a reason for hiding this comment

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

should we add a redirect for the bandit-assignment-logger?

<FeatureCard
title="API Reference"
description="Reference for all SDK methods."
link="https://github.com/Eppo-exp/java-server-sdk"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This just links to the github repo. It would be awesome to have an API reference site for the SDKs.

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.

2 participants