Redocly / Redocly/redoc

Markdown: Internal page navigation doesn't sync with URL

Open
#2,203 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Whenever a internal page navigation links which points to tags are clicked, the control navigates to correct tag but an incorrect URL is updated in the URL bar of the documentation.

Expected behavior
The correct URL which matches with the navigated position should be updated
`
openapi: 3.1.0
info:
title: Documentation
version: 1.0.0
description: >
# Introduction
some text LoginLink
Some text for QueryLink.
x-logo:
url: logo.png

tags:

  • name: Login
    description: Description for Login
  • name: Query
    description: Description for Query
    paths:
    /login:
    post:
    operationId: Login
    tags:
    - Login
    summary: Login
    description: Login Description
    requestBody:
    content:
    application/json:
    schema:
    $ref: 'InputSchema'
    required: true
    responses:
    '200':
    description: Successful login
    content:
    ...
    ...

/query:
post:
operationId: Query
tags:
- Query
summary: Query
description: >-
Sample Description for query
`

Screenshots
OpenapierrorScreenshot

In the screenshot above, when the query link is clicked, it is navigated to the Query tag correctly, but the URL is updated to the tag corresponding to the login tag.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides an OpenAPI example and screenshot but names no implementation file, entry point, or test. Reproduce the tag-link navigation with the supplied example, trace the URL update and scrolling behavior, and verify that each clicked tag produces a matching URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.