A developer friendly documentation page

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
html
Domain
design, documentation

Research direction

Start by reviewing the current documentation page and its navigation, then compare the requested experience with the linked Stripe API documentation. Identify how the existing site structures documentation pages before scoping sticky navigation and dark/light themes. Done means developers can navigate the documentation without returning to the top and can choose an appropriate theme.

Written by the indexing model from the issue text.

Description

Search terms you've used
documentation, developer centric, UI

Is your feature request related to a problem? Please describe.
It's frustrating that developers have to go to the top of page to navigate through the doc content.

Describe the solution you'd like
Probably make one like https://stripe.com/docs/api, with sticky siden av
Including dark/light theme for developers to browse doc at night/day

Describe alternatives you've considered

Additional context
Add any other context or screenshots about the feature request here.

Dominant language
HTML
Stars
183
Forks
154
No merged PRs in 30d

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.

More from solid/solidproject.org

All issues in solid/solidproject.org

Similar issues

More Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.