Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

13.3R/readme: corrections, changes #346

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

grahamperrin
Copy link
Contributor

Fix the link to the FreeBSD Handbook bibliography. 

Sentence markup.
…

Affects:

https://www.freebsd.org/releases/13.3R/readme/

The current link results in the first page, not the bibliography.

Attempt to fix this.
A number of other files provide more specific information about this {releaseType} distribution. These files are provided in various formats. Most distributions will include both ASCII text ([.filename]`.TXT`) and HTML ([.filename]`.HTM`) renditions. Some distributions may also include other formats such as Portable Document Format ([.filename]`.PDF`).
A number of other files provide more specific information about this {releaseType} distribution.
These files are provided in various formats.
Most distributions will include both ASCII text ([.filename]`.TXT`) and HTML ([.filename]`.HTM`) renditions.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it still true that most distributions include all four of README.TXT, RELNOTES.TXT, HARDWARE.TXT, and ERRATA.TXT – plus .HTM counterparts?

Without me digging: this smells, to me, like a type of statement that might be outdated. (If my sense of smell is mistaken: I'm probably misguided by https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=264483.)

@grahamperrin
Copy link
Contributor Author

The first paragraph under https://www.freebsd.org/releases/13.3R/readme/#about presents a range of platforms that seems to differ significantly, at least in number, from the 13.x column at https://www.freebsd.org/platforms/#_supported_platforms.

If the paragraph is wrong: consider simplification, not expansion (long-term reduction of documentation maintenance burden; be realistic about what can and will be automated).

@grahamperrin grahamperrin marked this pull request as ready for review March 3, 2024 19:18
freebsd-git pushed a commit that referenced this pull request Mar 4, 2024
Fix markup for link to bibliography in the handbook.  Part of
#346.

Obtained from:	grahamperrin@gmail.com
@grahamperrin
Copy link
Contributor Author

Thanks to Mike for the commit.

Context: this PR is amongst the responses to @cperciva at https://old.reddit.com/r/freebsd/comments/1b2so17/-/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant