Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Confusing sidebar navigation in "Building your first Solid app" tutorial

Open
  • Is something wrong?
#649 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Open the getting-started and first-app tutorial pages and compare their sidebar navigation. Check how the first-app page's sidebar links relate to its visible sections, then align it with the requested section-based navigation; done means the sidebar lists the page breakdown and its links scroll to the corresponding sections without duplicate or unrelated entries.

Written by the indexing model from the issue text.

Description

Search terms you've used

https://github.com/solid/solidproject.org/search?q=navigation&type=issues

I found https://github.com/solid/solidproject.org/issues/237 where this comment could be appropriate, but it looks like an old issue, and doesn't look likely that this bug report will be seen due to the lack of comments there.

https://github.com/solid/solidproject.org/search?q=getting+started&type=issues
https://github.com/solid/solidproject.org/search?q=tutorial&type=issues

Nothing appropriate found.

Describe the bug

The sidebar navigation on this page is very confusing, as it does not align with the sidebar navigation logic of the previous page.

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://solidproject.org/developers/tutorials/getting-started
  2. Click on "developing your own app"
  3. See confusing sidebar

Expected behavior

I would expect the sidebar on https://solidproject.org/developers/tutorials/first-app to have a similar logic to that of https://solidproject.org/developers/tutorials/getting-started. That means, I'd expect something that just has the current page breakdown, listing subsections that one can click on, and it will automatically scroll to the appropriate section. Currently, the links go to external sites, and they are seemingly unrelated to the contents of the page. There are two "Getting Started" links (which is very confusing), and a hidden link after the second "Getting Started" and before the "Vocabularies" which just links to the "Vocabularies" page.

Ideally, I'd expect that that the three links listed at the top of the page ("Prerequisites", "Build the Application", "Run the Application") would be listed on the sidebar instead, but serve the same function that those links currently do (i.e., scroll to the appropriate sections). I guess we'd also need "Additional information" here, as well as the list of subsections.

Screenshots

Screenshot 2021-11-07 at 17 31 42

Desktop

  • OS: MacOS Catalina
  • Browser: Chrome
  • Version: 95.0.4638.69
Dominant language
HTML
Stars
183
Forks
158
Avg merge
8h 28m
Merged PRs (30d)
1

Getting set up

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.

More from solid/solidproject.org

All issues in solid/solidproject.org

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.