parse-community / parse-community/docs

🐛 Navigation links in the API page are broken

Open Beginner friendly
#889 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:bug
Dominant language
SCSS
Stars
317
Forks
507
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
The links in the parse-server API page are broken. Clicking on them changes the page hash but doesn't scroll to the associated section.

To Reproduce
Steps to reproduce the behavior:

  1. Go to the webpage
  2. Scroll down to the nav links below the sponsors
  3. Click on any of the links, none work.

Expected behavior
Clicking on the link should scroll to the associated section.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
One solution is to simply add the id attribute to all the headings so that the browser handles the scrolling without any additional config. For example for the "Using Environment Variables" link, the hash changes to #using-environment-variables, so the associated <h2> in the page should have id="using-environment-variables". This should be done for all the nav links.

Contributor guide

No contributing guide indexed for this repository

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

Open the parse-server API page and inspect the source that generates its navigation links and section headings. Compare each link hash, such as #using-environment-variables, with the corresponding heading and ensure the generated page scrolls to every linked section. Verify the result by clicking the navigation links on the API page.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, jekyll
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.