swiftlang / swiftlang/docs

"Swift" link under "Libraries" on the main page is non-obvious

Open
#154 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content error enhancement
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Description

Page URL

https://docs.swift.org/latest/documentation/

Description

The distinction between "Swift" (particularly when not in code voice) versus "The Swift Programming Language" is non-obvious to the beginner.

Although the boundary of what's considered "standard library" is perhaps not entirely settled, given that clicking through gives us a page where the left-hand nav shows "Standard Library" as the title, it may be the closest consistent usage suitable for the link, page header, and left-hand nav.

(And perhaps the "Standard Library > Swift Standard Library" subcategory might then resurface the internal name "Core" or something like that. Some of this nomenclature probably needs LSG sign-off.)

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.

Research direction

Start at the documentation page at https://docs.swift.org/latest/documentation/ and inspect the “Swift” link under “Libraries,” then follow its destination and compare the page header with the left-hand navigation. Confirm the preferred terminology with the relevant LSG reviewers. Done means the link, page header, and navigation use consistent beginner-facing names.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.