golang/go

x/website: automatic URL fragments for sub-sections of 'Minor changes to the library' are overly repetitive

Open

#70847 opened on Dec 14, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (133,883 stars) (19,008 forks)batch import
NeedsInvestigationhelp wantedwebsite

Description

Is something duplicating the fragment names in the release notes?

https://tip.golang.org/doc/go1.24#gotypespkggotypes https://tip.golang.org/doc/go1.24#encodingjsonpkgencodingjson https://tip.golang.org/doc/go1.24#archivepkgarchive

I'd expect just archive or pkgarchive at most.

Others are pretty: https://tip.golang.org/doc/go1.24#runtime (which is why I guess the pkg is in there, to distinguish it from https://tip.golang.org/doc/go1.24#runtimepkgruntime ... but that's two runtime in that fragment)

/cc @dmitshur

Contributor guide

Tech stack
gohtmlcss
Domain
documentationfrontend
Issue type
bug
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programming basicsHTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate how URL fragments are generated in the Go website release notes. Look at the template or code that produces fragments like 'gotypespkggotypes' and 'encodingjsonpkgencodingjson'. The goal is to make them shorter and non repetitive (e.g., just 'archive' or 'pkgarchive'). Check the related code in the x/website repository, possibly in the doc directory or the release notes generation tool.