Skip to content

About

FreeBSD doc tree (read-only mirror)

Resources

Stars

395 stars

Watchers

43 watching

Forks

Repository files navigation

FreeBSD Documentation Project

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.

Contributing

  • The Doc Project Primer covers building, toolchain, and style guidelines.
  • Submit patches on Differential, make sure to tag them with #docs! We're volunteers, comment ping after two weeks without a reply!
  • Use git format-patch against the main branch, and keep each change focused on one topic.
  • Discuss larger changes on the documentation project mailing list.

Repository layout

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/).

About

FreeBSD doc tree (read-only mirror)

Resources

Stars

395 stars

Watchers

43 watching

Forks

Releases

Packages

Used by

Contributors

Languages