Page MenuHomeFreeBSD
Files F177558665

D61254.1794717658.diff
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

D61254.1794717658.diff
View Options

diff --git a/README b/README
deleted file mode 100644
--- a/README
+++ /dev/null
@@ -1,8 +0,0 @@
-If you plan on building a local copy of the FreeBSD documentation, or using
-our toolchain in your own projects, please read the Documentation Primer at:
-
- https://docs.freebsd.org/en/books/fdp-primer/
-
-for information about the tools and formatting languages we use.
-Chapter 1 has a Quick Start section, and Chapter 2 covers the software
-and related items in more detail.
diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# FreeBSD Documentation Project
+
+This is the top level of the documentation project source code.
+It contains the [project website](https://www.FreeBSD.org/) and
+[documentation](https://docs.FreeBSD.org/) artifacts: the Handbook, FAQ,
+Porter's Handbook, Developer's Handbook, articles, and translations.
+
+The content is written in [AsciiDoc](https://asciidoc.org/) and built
+with [Hugo](https://gohugo.io/). Install the `docproj` package to get
+started.
+
+## Contributing
+- The [Doc Project Primer](https://docs.FreeBSD.org/en/books/fdp-primer)
+ covers building, toolchain, and style guidelines.
+- Submit patches on [Differential](https://reviews.FreeBSD.org/),
+ 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](https://lists.FreeBSD.org/subscription/freebsd-doc).
+
+## 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/`).
+

File Metadata

Mime Type
text/plain
Expires
Sun, Nov 15, 4:40 AM (19 h, 28 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
41706756
Default Alt Text
D61254.1794717658.diff (2 KB)

Event Timeline