Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.md to change the Markdown title in the doc from APIs to … #7668

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Coderambling
Copy link
Contributor

@Coderambling Coderambling commented 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 trail 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: #7663 .

Proposed new filename: overview_of_apis.md

https://github.com/holoviz/panel/blob/main/doc/explanation/api/index.md?plain=1

…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
@philippjfr
Copy link
Member

Is the title shown in the breadcrumb tale based on the Markdown title or the filename?

Neither, it's based on the table of contents entry.

@Coderambling
Copy link
Contributor Author

Coderambling commented Feb 3, 2025

Thanks! So from what content or properties is the entry in the Table of Contents generated? Or is it based on manual edits of the entries in a ToC file?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants