novuhq/docs

Novu documentation - The Masterpiece

docs's Issues

Add Curl Request Examples for Workflow API in API Reference Documentation

At the moment, we have request examples for different technologies, Node.js, PHP, Ruby, Go in the API Reference documentation.

Now, we need a request example for Curl for the Workflow API in the API reference documentation

• Get workflows
• Create Workflow
• Get Workflow
• Update Workflow
• Delete Workflow
• Update Workflow Status

Add Curl Request Examples for Execution Details API in API Reference Documentation

At the moment, it has request examples for different technologies, Node.js, PHP, Ruby, Go in the API Reference documentation.
I'd like to add the respective curl request example for Execution Details API as well.

I'll be taking reference from following:

• https://docs.novu.co/api-reference/execution-details/get-execution-details
• https://api.novu.co/api#/Execution%20Details/ExecutionDetailsController_getExecutionDetailsForNotification

Missing response data in docs. https://docs.novu.co/api-reference/subscribers/handle-chat-oauth

The below mentioned link shows the portion of the docs where the response data is missing.

Issue is also raised here, But I think this repo is the correct place: novuhq/novu#4192
Docs Link

P.S : Can I be assigned to solve this issue?

Error in Demo section of docs

@unicodeveloper is these the issue or some sort of other type of error?

Issue on docs

Path: /getting-started/introduction

add Firetext sms provider documentation

add plunk email provider documentation

Add Elixir Quickstart & SDK Documentation

We have quickstarts for all our SDKs and libraries. There's an Elixir SDKwithout a quickstart.

A quickstart needs to be written for Elixir users to quickly get started with the Elixir SDK.

Good examples that can guide you to write a great Elixir Novu quickstart are the Node.js & Kotlin quickstart guides.

We also need an SDK listing for Elixir under Server Side.

• Elixir Quickstart
• Elixir SDK Listing under Server Side

Improve UX design of the community page

Currently the Community Page is text heavy and uses hyper links.
I propose to beautify it by using cards and icons to represent the same information instead of using hyperlinks.
Kindly assign this issue so as to work on it.

Clicking on "Suggest edits" opens main branch edit page

When clicking on the "Suggest edits" button from the documentation site, the Github edit page is opened up on the main branch. This behaviour conflicts with the Publishing Changes section in the Readme which asks for changes to be submitted against the staging branch, and results in a non-optimal DX for contributors.

For example, my previous PR (#70) was opened through the "Suggest edits" feature and defaulted to merging to main - this branch mismatch was not caught during review.

Unfortunately, it's not possible to setup Github branch protection to enforce that pull requests come from a specific branch, but it is possible to setup a Github workflow for this check (see https://stackoverflow.com/a/75414339/19305547).

Possible fixes:

• Investigate if Mintlify config supports specifying a base branch for the "Suggest edits" feature
• Implement Github workflow to enforce merges to main come only from staging

Cards missing in the Overview Page

Currently there are 15 quickstart pages for all languages however only 10 cards are present in the Overview page (https://docs.novu.co/quickstarts/01-introduction) linking to the quickstart. Missing Cards and Links are for:

1. Vanilla JS
2. Redwood JS
3. Iframe
4. Node JS
5. Next JS

Proposal: Adding the cards and correct links so that user can access thee preferred quickstart directly form the overview page.
Kindly assign this to me so that i can work on it!

Poor contrast in the reading mode toggle switch

Currently, the light mode-dark mode toggle switch has a really poor contrast for the grey background bar, making it almost invisible in the light mode and only visible clearly in the dark mode.

Add Clickatell sms provider documentation

Add Kannel sms provider documentation

Issue on docs - Missing API Keys field in API Reference

Path: /api-reference/

Unable to enter API Keys because of missing field for testing each of these endpoints in the API Reference doc.
I tried opening the API reference in incognito mode but that did not help.

Screenshot:

Add proper Python documentation

Issue on docs: Python logo

Path: /sdks/introduction

The Python logo has a red shade to it as opposed to the standard blue and yellow colour.

@unicodeveloper, do assign me to this issue.

Add Curl Request Examples for Events API in API Reference Documentation

At the moment, we have request examples for different technologies, Node.js, PHP, Ruby, Go in the API Reference documentation.

Now, we need a request example for Curl for the Events API in the API reference documentation

• Trigger event,
• Bulk Trigger event
• Broadcast event to all
• Cancel triggered event

Adding the Ruby and Kotlin icon under Start Point page

Currently Ruby and Kotlin Icons are not displayed in the Getting started page so need to add the same.

Add alt-text to images in the Activity page

There are many images and videos on the Activity page that have no alt attribute, which makes the site non-accessible. This needs to be fixed.

Wrong novu's linkedin handle in the docs

Problem:

In the footer of the docs, There is a wrong linkedin handle which is https://www.linkedin.com/company/novuhq/

Solution:
Changed the wrong handle to correct one which is https://www.linkedin.com/company/novuco/

P.S. Can you assign to me to resolve this issue?

Add an explanation of the difference between Notification vs Message vs Feed

Path: /overview/introduction

Add Curl Request Examples for Workflow Groups API in API Reference Documentation

At the moment, we have request examples for different technologies, Node.js, PHP, Ruby, Go in the API Reference documentation.

Now, we need request examples for Curl for the Workflow groups API in the API reference documentation

• Get workflow groups
• Create workflow group
• Get workflow group
• Delete workflow group
• Update workflow group

Add FortySixElks sms provider documentation

Wrong redirect url in FAQ Section of docs

Problem

In the FAQ section, There is a question as "I am missing a channel provider, can I ask for one? Or add it myself?" and In the answer, There is the link to contribute the provider which redirect to wrong URL that is https://docs.novu.co/community/create-provider

Expected Solution:

Update the wrong URL from https://docs.novu.co/community/create-provider to https://docs.novu.co/community/add-a-new-provider.

Can you assign to me to resolve this issue?

Add instructions and command to run novu in windows machine

Our current documentation is for Mac/Linux users. The user who is using a windows machine is getting issues.
https://docs.novu.co/community/run-in-local-machine

A prerequisite to work on this issue is to have a window system and complete all steps to run Novu in that machine.

Add .nvmrc for node version

Issue

mintlify needs atleast node version 18 as per this error thrown when using prior versions:

mintlify dev
✖ Mintlify requires a node version >= 18.0.0 (current version 16.15.1). Try removing the mintlify package, upgrading node, reinstalling mintlify, and running again.

Solution

Adding a .nvmrc would help packages like nvm and fnm manage node versions automatically.

add mattermost chat provider documentation

Add alt attribute to the images and assets used in Concepts page

Many menu screenshots in the Concepts page in the guide have no alt text associated with them. This makes the site less accessible to screen readers. This should be addressed.

add gupshup sms provider documentation

Chat - wrong use of variables

Path: /content-creation-design/notification-content-creation

There are wrong use of the brackets in Chat

Mistake in the redirect url of .NET quickstart in different section

Observed Problem:

• In the SDK section of C#/.NET (https://docs.novu.co/sdks/dotnet), There is a link to redirect to .NET Quickstart just below the installation step which redirect to wrong url that is https://docs.novu.co/getting-started/introduction.

• Just as same problem mentioned above, In the Overview section of quickstart (https://docs.novu.co/quickstarts/01-introduction),
  There is a box of .NET quickstart which also redirect to wrong url.

Correction Needed:

Change the wrong url to correct one that is https://docs.novu.co/quickstarts/.NET

P.S: Can you assign to me to resolve this issue?

Need Change Twitter logo to X logo

In the footer logo section, the Twitter logo is an old logo that must be changed to the current one.

How to reproduce:-
You can see it in any footer section of any page.

Incomplete information In docs. https://docs.novu.co/api-reference/subscribers/handle-providers-oauth-redirect

The below mentioned link shows the portion of the docs where the response data is missing.

Issue is also raised here, But I think this repo is the correct place: novuhq/novu#4191

Docs Link

P.S : Can I be assigned to solve this issue?

Inconsistent api response for `Delete Feed` endpoint

The api endpoint for Create Feed returns an object:

{
  "data": {
    "_id": "string",
    "name": "string",
    "identifier": "string",
    "_environmentId": "string",
    "_organizationId": "string"
  }
}

but the response of Delete Feed returns an array of objects:

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "identifier": "string",
      "_environmentId": "string",
      "_organizationId": "string"
    }
  ]
}

To be consistent, Delete Feed should not return an array or the Create Feed should return an array as well.

Issue on docs

Path: /api-reference/events/cancel-triggered-event

According to the doc it says that we can cancel a triggered event (delay etc) using novu.subscribers.cancel("transactionId");

But when I tried to use this it gave the following error: Property 'cancel' does not exist on type 'Subscribers'.

On checking the types of 'Subscribers', I found that there is no such function. I am on version 0.18.0

Please check this and update the doc accordingly if required.

Icons not visible

In the documentation for SDK's icon of ruby and kotlin are not visible as shown in the screenshot.

Kindly assign me this issue to rectify this problem.

Replacing Readme.md links with Markdown badges

• instead of having these we can have markdown badges is my suggestion ? if so then i would like to work on this issue
  

Wrong endpoint(url) in the subscribers attributes

Problem

There is a wrong redirect URL in the subscribers attributes text on the second point of On Filter (Click here) which redirects to wrong endpoint that is https://docs.novu.co/getting-started/introduction#subscriber-attributes

Solution

It can be solved by changing the wrong endpoint with correct one that is https://docs.novu.co/subscribers/subscribers#subscriber-attributes

P.S Can you assign to me to resolve this issue?

Add email webhook provider documentation

add BurstSms sms provider documentation

Issue on docs: Wrong Response Body specified in Get-Workflows API Reference

Path: /api-reference/workflows/get-workflows

When you click on the dropdown arrow, the response body specified there is not a true representation of what the response body should look like

Concepts - add links to docs page

Path: /getting-started/concepts

We should add a link to the fitting doc page of each concept. For example - Digest -> will have a link to the page of Digest

Also- maybe include Filters as well in the concepts?

Add Laravel Quickstart Documentation

We have quickstarts for all our SDKs and libraries. There's a Laravel SDK without a quickstart.

A quickstart needs to be written for Laravel users to quickly get started with the Laravel SDK.

A good example that can guide you to write a great Laravel Novu quickstart is the PHP quickstart guide.

Issue on docs

Path: /api-reference/integrations/get-v1integrationsin-appstatus

As mentioned in novuhq/novu#4406. The endpoint "/v1/integrations/in-app/status" is not public today. I think there should be an warning or some kind of message saying same. As not having this kind of message may lead to confusion of developers.

I would like to make those changes. Assign it to me. Can you assign it to me.

Improve the UX of Demo page

Currently there are only github and demo links in the page which do not look appealing to the user.
Proposing to use cards and butttons along with icons to improve the UX of the page.

Kindly assign this issue to me so that the improvement can be brought upon!

Add Maqsam sms provider documentation

Add SmsCentral sms provider documentation

Adding the missing icons to SDK Navigation Bar

Currently icons for the SDK's in the Navigation bar are missing unlike as in the case for quickstart.

Proposed: To add the icons to SDK Navigation bar create uniformity between UX across pages.

Kindly assign this issue to me so that i can add the PR for this!

Issue on docs

Path: /sdks/java not compatible with quarkus