oss/freebsd-doc
Watch
1
0
Fork
You've already forked freebsd-doc
 0
mirror of https://github.com/freebsd/freebsd-doc synced 2026-11-09 16:17:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
61,444 commits 3 branches 79 tags 615 MiB
  • HTML 97.5%
  • Perl 1.5%
  • CSS 0.5%
  • Raku 0.2%
  • Shell 0.1%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Colin Percival c13dc75acf 15.2: Announce BETA1 
Approved by:	re (implicit)
2026-11-06 16:40:43 -07:00
.github GitHub Actions: Add a labeler action 2023-03-15 09:51:16 +01:00
.hooks Add the prepare-commit-msg hook to the repository 2022-08-16 21:33:25 +08:00
.vale Fix documentation CI 2025-02-17 22:55:11 +01:00
documentation pgpkeys: Update key for rcm 2026-11-01 15:04:42 -05:00
shared Add EoL dates for all 14.x and 15.x releases 2026-11-06 00:07:18 +00:00
tools Status/sendcalls: Update deadlines 2026-02-27 14:01:20 +01:00
website 15.2: Announce BETA1 2026-11-06 16:40:43 -07:00
.arcconfig Migrate doc to Hugo/AsciiDoctor 2021-01-26 00:31:29 +01:00
.cirrus.yml .cirrus.yml: Change to 14.0-RELEASE 2024-05-03 23:23:20 -03:00
.gitattributes Initialize .gitattributes for doc 2025-06-12 11:44:51 -04:00
.gitignore Add a .gitignore file 2023-12-17 20:41:34 +01:00
.mailmap mailmap: Add entry for longros 2026-10-20 19:45:15 +02:00
.vale.ini .vale/styles: Removing Foreign Language references from English contents 2023-08-01 15:27:37 +02:00
COPYRIGHT Copyright: Bump year 2026-02-19 11:22:05 +01:00
Makefile Makefiles: Reflow 2026-05-21 11:02:17 -04:00
README.md README: Scrap and write a new one in Markdown 2026-11-06 16:40:06 -05:00

README.md

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