golang/go

x/pkgsite: trim the non text elements from subdirectories synopsis

Open

#42,335 opened on Nov 2, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
NeedsInvestigationhelp wantedpkgsitepkgsite/dochtml

Repository metrics

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

Description

synopsis here (I believe this is the line https://github.com/golang/pkgsite/blob/master/content/static/html/pages/subdirectories.tmpl#L19) looks really awkward image as opposed to the image

may I suggest rendering that synopsis to html and removing all non text html elements from that section? something like this might work

depth := 0
summary := bytes.NewBuffer(nil)
for {
	tt := z.Next()
	switch tt {
	case html.ErrorToken:
		break
	case html.TextToken:
		summary.Write(z.Text())
}
return summary.String()

Contributor guide

Research direction
Implement a simple HTML tokenizer to extract only text content from the synopsis, and update the subdirectories.tmpl template or backend logic to use it.
Tech stack
go
Domain
backend
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.
Under 1 hour
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
GoHTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70