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

Issue on docs: getting a Java instance of Novu #274

Open
tedyoung opened this issue Oct 19, 2023 · 0 comments
Open

Issue on docs: getting a Java instance of Novu #274

tedyoung opened this issue Oct 19, 2023 · 0 comments

Comments

@tedyoung
Copy link

tedyoung commented Oct 19, 2023

Path: /sdks/java

The first page a Java developer sees is this one, which confuses me because the first code example already has two different ways of getting a Novu instance:

        // Using the API Key only
        Novu novu = new Novu(apiKey);

        // Using the Config Param
        NovuConfig novuConfig = new NovuConfig(apiKey);
        Novu novu = new Novu(novuConfig);

Nowhere in this example or on the containing page does it explain the difference between using an apiKey directly in the Novu constructor, or using NovuConfig. Perhaps a simpler, but also more useful example could be used and leave the (probably more complicated) usage of NovuConfig for later?

I'm not even sure the "Usage" section is even useful, if the real docs for Java are under the Quickstart at https://docs.novu.co/quickstarts/java. Are there plans for adding more docs to this page?

Also, the Quickstart page has the same problem: showing both ways to instantiate Novu without saying why to use one over the other, and no links to more specific API docs for the constructor.

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

No branches or pull requests

1 participant