Skip to content

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

@tedyoung

Description

@tedyoung

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions