This is the top level of the documentation project source code. It contains the project website and documentation artifacts: the Handbook, FAQ, Porter's Handbook, Developer's Handbook, articles, and translations.
The content is written in AsciiDoc and built
with Hugo. Install the docproj package to get
started.
- The Doc Project Primer covers building, toolchain, and style guidelines.
- Submit patches on Differential,
make sure to tag them with
#docs! We're volunteers, commentpingafter two weeks without a reply! - Use
git format-patchagainst themainbranch, and keep each change focused on one topic. - Discuss larger changes on the documentation project mailing list.
| Path | Contents |
|---|---|
documentation/ |
docs.FreeBSD.org: books, articles, and web portal |
website/ |
releases, security advisories, news, and events |
shared/ |
macros, attributes, and shared assets |
tools/ |
helper scripts |
Translations live alongside the English originals under per-language
directories (e.g., documentation/content/ru/).