starred/panel-pelican-dev
1
0
Fork 0
mirror of https://github.com/pelican-dev/panel.git synced 2026-05-04 18:00:48 +03:00
Code Issues 41 Packages Projects Releases 10 Wiki Activity

API Documentation Not Accessible via User Interface #356

New Issue
Closed
opened 2026-02-05 17:29:15 +03:00 by OVERLORD · 1 comment
OVERLORD commented 2026-02-05 17:29:15 +03:00
Owner
Copy Link

Originally created by @TigerdieKatze on GitHub (Jun 2, 2025).

Problem Description

Users cannot easily access API documentation through the application's user interface. Currently, the API docs are difficult to locate, which creates friction for developers trying to integrate with the system.

Current Behavior

  • API documentation is not reachable through standard UI navigation
  • No clear path from the main interface to API resources
  • Users must search externally or guess URLs to find documentation

Expected Behavior

  • Clear navigation path to API documentation from the main UI
  • Dedicated section or button in the admin/developer area
  • Easy discoverability for new users and developers

Proposed Solution

Add a button or navigation link in /admin/api-keys that redirects users to /docs/api/ or the appropriate API documentation location.

Steps to Reproduce

  1. Navigate to the main application interface
  2. Look for API documentation links
  3. Check admin sections for API-related resources
  4. Observe that no clear path exists :(

Acceptance Criteria

  • Link/button is clearly labeled and discoverable
Originally created by @TigerdieKatze on GitHub (Jun 2, 2025). ## Problem Description Users cannot easily access API documentation through the application's user interface. Currently, the API docs are difficult to locate, which creates friction for developers trying to integrate with the system. ## Current Behavior - API documentation is not reachable through standard UI navigation - No clear path from the main interface to API resources - Users must search externally or guess URLs to find documentation ## Expected Behavior - Clear navigation path to API documentation from the main UI - Dedicated section or button in the admin/developer area - Easy discoverability for new users and developers ## Proposed Solution Add a button or navigation link in `/admin/api-keys` that redirects users to `/docs/api/` or the appropriate API documentation location. ## Steps to Reproduce 1. Navigate to the main application interface 2. Look for API documentation links 3. Check admin sections for API-related resources 4. Observe that no clear path exists :( ## Acceptance Criteria - [ ] Link/button is clearly labeled and discoverable
OVERLORD commented 2026-02-05 17:29:18 +03:00
Author
Owner
Copy Link

@Boy132 commented on GitHub (Jun 3, 2025):

The api docs integrated in the panel will be removed eventually and added to our website.
Right now the best place for developers is to ask on the Discord. (also because the api docs are incomplete)

@Boy132 commented on GitHub (Jun 3, 2025): The api docs integrated in the panel will be removed eventually and added to our website. Right now the best place for developers is to ask on the Discord. (also because the api docs are incomplete)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
not confirmed
pull-request
Mirrored from GitHub Pull Request
 👑 sponsor
💰 fund
🔴 hard
🟡 medium
🟡 medium
🟡 medium
🟢 easy
🟢 easy
🟢 easy
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/panel-pelican-dev#356
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?