polarsource / polar

An open source Merchant of Record. Sell SaaS and digital products in minutes.
https://polar.sh
Apache License 2.0
3.14k stars 136 forks source link

Root API endpoint (`/`) 404 vs. offers direction #4497

Open hlevring opened 3 days ago

hlevring commented 3 days ago

Description

https://api.polar.sh is broken

Current Behavior

If you visit https://docs.polar.sh/api#feedback Clicking https://api.polar.sh/ shows a page saying "details not found"

Expected Behavior

Link should work

Screenshots

image

Environment:


birkjernstrom commented 3 days ago

(Updated title a bit)

Thank you @hlevring. We should make sure the reference to the API url is not an actual link in the docs & spruce up the index page on: docs.polar.sh/api to provide more initial direction like docs.polar.sh/developers

But the API definitely works and has a lot of endpoints available to integrate Polar & manage your organization and store. You can follow our (https://docs.polar.sh/developers) for examples.

We should, however, offer a more friendly response under the non-existent / root endpoint of our API with suggestions on the first guides or something to review. Would be a nice & nerdy enhancement 🤓