Skip to content

Add API reference for onboarding, gamification, and notifications#299

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/api-engagement-1775279094
Open

Add API reference for onboarding, gamification, and notifications#299
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/api-engagement-1775279094

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 4, 2026

Summary

  • Added API reference pages for the new onboarding, gamification, and notifications systems
  • Onboarding: step-by-step progress tracking with auto-completion, skip, and manual step completion
  • Gamification: badges, points, levels, login streaks, badge checks, and leaderboard
  • Notifications: in-app notifications for badges, referrals, level-ups, deployments, and streaks
  • Updated the API overview endpoint reference table with all new endpoints
  • Added new pages to the docs.json navigation under API Reference

Open in Devin Review

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mintlify-docs Ready Ready Preview, Comment Apr 25, 2026 11:24am

Request Review

Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

View 2 additional findings in Devin Review.

Open in Devin Review

Comment on lines +1 to +4
---
title: Notifications API
description: "In-app notification system for badges, referrals, achievements, and system events"
---
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 New documentation pages not added to docs.json navigation

The new pages api-reference/notifications.mdx and api-reference/onboarding.mdx are created but not registered in the docs.json navigation configuration (docs.json:96-183). Mintlify uses this configuration to build the sidebar navigation. Without entries for "api-reference/onboarding" and "api-reference/notifications" in the pages array of the "API Reference" group, these pages will be orphaned — they exist on the site but users cannot discover them through the sidebar. They would only be reachable via direct URL or internal links from other pages.

Prompt for agents
The new pages api-reference/notifications.mdx and api-reference/onboarding.mdx need to be added to the navigation in docs.json. In docs.json, find the "API Reference" group (around line 95-183) and add "api-reference/onboarding" and "api-reference/notifications" to the pages array. A logical placement would be near the existing related pages like api-reference/referrals and api-reference/gamification (around line 156-157). For example, add them as: "api-reference/onboarding", "api-reference/notifications" after the gamification entry.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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.

1 participant