Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 09 Jan 2022 16:05:16 +0000
From:      bugzilla-noreply@freebsd.org
To:        doc@FreeBSD.org
Subject:   [Bug 261064] /docs/ minor update; orientation; put the new documentation site, and its content, in context
Message-ID:  <bug-261064-9@https.bugs.freebsd.org/bugzilla/>

next in thread | raw e-mail | index | archive | help
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D261064

            Bug ID: 261064
           Summary: /docs/ minor update; orientation; put the new
                    documentation site, and its content, in context
           Product: Documentation
           Version: Latest
          Hardware: Any
               URL: https://www.freebsd.org/docs/
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Website
          Assignee: doc@FreeBSD.org
          Reporter: grahamperrin@gmail.com

At <https://www.freebsd.org/docs/>; the most prominent link to 'documentatio=
n'
(in the sole single-sentence paragraph) refers to traditional:=20

<https://www.freebsd.org/docs/books/>;

=E2=80=93 ignoring (for a moment) the 'books' part of the URL, this is fine=
; there's a
variety of documentation from multiple domains.=20

We do have the two references to <https://docs.freebsd.org/en/>:=20

* 'Documentation' in the navigation bar

* 'Documentation' at the head of the sidebar

=E2=80=93 however the page itself <https://www.freebsd.org/docs/>; does not =
make clear
that the word documentation currently has two very different meanings
(different destinations).=20


Maybe re-word the existing paragraph. Something like:=20


> Our main <documentation site> comprises material that's managed by=20
> the FreeBSD Documentation Project. Contributions from the=20
> community are encouraged.=20
>=20
> Sidebar links, to the left, include:=20
>=20
> * the FreeBSD Handbook and other popular Documentation Project items
>=20
> * items from other areas, including the FreeBSD Foundation.


NB:=20

* no use of the word 'portal'

* no more than one link in the body text.


Then add a sidebar link 'Overview' (beneath 'Documentation') with reference=
 to
<https://www.freebsd.org/docs/books/>.

--=20
You are receiving this mail because:
You are the assignee for the bug.=



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?bug-261064-9>