golang/go

x/website: add regression tests HTML anchors of important docs don't change

Open

#61,499 opened on Jul 21, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wantedwebsite

Repository metrics

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

Description

Previously the documentation for go doc links was at: https://go.dev/doc/comment#doc-links Now it is at: https://go.dev/doc/comment#doclinks The difference is in the hashref.

As now both links are in use (probably mostly by myself as I am a big promoter of godoc links), a redirect would be helpful.

Contributor guide

Research direction
Inspect the current documentation anchors and identify all changed hashrefs. Write a regression test to ensure they remain stable, or propose a redirect mechanism.
Tech stack
go
Domain
documentationweb dev
Issue type
Test
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoHTMLGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75