bharel / bharel/mkdocs-render-swagger-plugin

Table of Contents (TOC)

Open
#29 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
78
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Hello, thank you for the effort that went into creating this project. I was wondering if it would be possible to add support for rendering a table of contents (TOC) of the API endpoints on the right of the page, which is a feature I am used to in MkDocs.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no file, test, or entry point. Start by tracing the plugin's MkDocs rendering path and existing Swagger/OpenAPI integration, then identify how endpoint navigation is assembled and define the expected table-of-contents behavior before estimating the change.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.