pulp / pulp/pulp-docs

Index pages edit button gives the wrong link

Open
#78 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Description

Because some pages are dynamically moved by pulp-docs, the edit-button gives the wrong URL.

E.g:

# page
https://pulpproject.org/pulp_python/#summary

# wrong edit-btn url
https://github.com/pulp/pulp_python/edit/main/index.md

# right edit-btn url
https://github.com/pulp/pulp_python/blob/main/docs/index.md

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

No source file or test is named. Start by reproducing the edit-button URL for the dynamically moved index page shown in the example, then trace where that URL is generated for index pages. Done means the button points to docs/index.md rather than index.md, including for the demonstrated pulp_python page.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.