Skip to content

[docs]: The "Edit Page" button is not visible in the documentation for the stable branch. #17947

Open
@Mr-Sunglasses

Description

@Mr-Sunglasses

Documentation

while fixing issue #17870 , I opened the PR #17933 , after the merge of that PR, I noticed the following behavior:


When we view the latest branch, the "Edit" button is visible. This happens because Sphinx uses the GitHub repository link combined with the branch name to allow editing the specific source file of the documentation.

Screenshot 2024-10-15 at 2 24 58 AM


However, when we switch to the stable branch, the "Edit" button disappears. This is expected behavior with Sphinx since the stable docs are released using tags, and tagged releases aren't associated with branches that can be directly edited.

Screenshot 2024-10-15 at 2 25 06 AM


Screenshot 2024-10-15 at 2 53 42 AM


IMO, we need to further discuss whether this is the behavior we want or if we need to consider changing how we deploy our docs.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions