golang/go

x/pkgsite: Reset button for doc examples

Open

#17,223 opened on Sep 25, 2016

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
FeatureRequestToolshelp wantedpkgsite

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

example: https://golang.org/pkg/html/template/#example_Template_block

The only way to reset a code example when you mest up trying something is to refresh the page. This is annoying if you are on a large page. Note that ussualy you are just on this url https://golang.org/pkg/html/template without a hash tag to the example directly so your page wil jump up when you refresh.

Possible solutions update the hash tag when you expand the example

image

Or introduce a reset icon somewhere. (where and how i am not sure yet, feel free to discuss)

Contributor guide

Research direction
Inspect the x/pkgsite directory in the Go repository. Locate the frontend code that renders code examples on pkg.go.dev. Implement a reset button or update the URL hash to allow resetting the example without page reload.
Tech stack
go
Domain
frontenddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80