unkeyed / unkey

Open source API management platform
https://go.unkey.com
Other
3.87k stars 458 forks source link

[docs] #2485

Open Mstr-Creta opened 2 hours ago

Mstr-Creta commented 2 hours ago

Type of documentation issue

Missing Information

Describe the problem and the proposed solution

Problem: Incomplete API Documentation

The current Unkey API documentation lacks critical context, clear guidance for getting started, best practices for secure implementation, and detailed examples of API usage. This makes it harder for developers to understand and integrate the API effectively.

Proposed Solution: Enhanced Documentation

The enhanced documentation will:

  1. Provide Context: Explain key concepts like passkey authentication, WebAuthn, and FIDO2.
  2. Step-by-Step Guides: Include practical, easy-to-follow instructions for registering users and implementing authentication.
  3. Add Best Practices: Include guidelines for security, MFA, and device management.
  4. Detailed API Usage: Offer clear, real-world examples for each core API endpoint.

This will improve usability and help developers integrate Unkey securely and efficiently. UnkeyDoc.txt p developers integrate Unkey securely and efficiently.

linear[bot] commented 2 hours ago

ENG-1504 [docs]

Mstr-Creta commented 2 hours ago

I hav tried to update the doc https://www.unkey.com/docs/api-reference/authentication precisely. Please review