Commit ee411aa8d3 for openssl.org
commit ee411aa8d3369c7e7a939e41eb54d7ae0237c660
Author: Milan Broz <gmazyland@gmail.com>
Date: Thu Jul 23 22:02:31 2026 +0200
Add a note about internal documentation
Document internal subdirectory in doc/README.md.
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Norbert Pocs <norbertp@openssl.org>
MergeDate: Fri Aug 7 13:30:30 2026
(Merged from https://github.com/openssl/openssl/pull/32058)
diff --git a/doc/README.md b/doc/README.md
index d999b0262b..505f48856b 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -22,5 +22,9 @@ README.md This file
Overviews; start with crypto.pod and ssl.pod, for example
Algorithm specific EVP_PKEY documentation.
+Directories above should contain public information and API documentation.
+For internal documentation (like an API included with headers in
+include/internal), use [internal/](internal/) directory.
+
Formatted versions of the manpages (apps,ssl,crypto) can be found at
<https://docs.openssl.org/master/>