In docs, the API doc shows > Explanation > APIs > APIs in the breadcrumb trail #7663
Comments
Coderambling
changed the title
Coderambling
added a commit
to Coderambling/panel
that referenced
this issue
Jan 26, 2025
…Overview of Panel APIs Update doc / explanation / api / index.md to change the Markdown title in the doc from APIs to Overview of Panel APIs. Is the title shown in the breadcrumb tale based on the Markdown title or the filename? In the latter case, the filename should also be changed, to improve clarity and avoid duplication, as described in this issue: holoviz#7663 . Proposed new filename: overview_of_apis.md https://github.com/holoviz/panel/blob/main/doc/explanation/api/index.md?plain=1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The doc below shows In shows Home > Explanation > Aps > APIs in the breadcrumb trail.
https://panel.holoviz.org/explanation/api/index.html . In the left sidebar, the document is called "API context", and is a sub item of Explanation, APIs.
The title of the document itself seems to be: "APIs". Maybe it should be called APIs explanation or Overview of APIs?
The doc is located in /explanation/api/index.md . https://github.com/holoviz/panel/blob/main/doc/explanation/api/index.md?plain=1
The first of the "APIs" in the breadcrumb trail links to
https://panel.holoviz.org/explanation/apis.html
which then forwards to:
https://panel.holoviz.org/explanation/index.html#apis
The "Explanations" element of the breadcrumbs trail leads to:
https://panel.holoviz.org/explanation/index.html
The Markdown title of the .md doc is # APIs . Should it be changed to API explanation or API overview?
The text was updated successfully, but these errors were encountered: