From c412919c93a1547cb3a2f1a92b140d78cb89e8f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vo=C5=99=C3=AD=C5=A1ek?= Date: Fri, 8 Mar 2024 11:31:25 +0100 Subject: [PATCH] Add hosted docs link to docs/README.md Closes GH-13633 --- docs/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index b845375c30933..fbd58155a5141 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,9 @@ # php-src docs -This is the home of the php-src internal documentation. It is in very early stages, but is intended -to become the primary place where new information about php-src is documented. Over time, it is -expected to replace various mediums like: +This is the home of the php-src internal documentation, hosted at +[php.github.io/php-src/](https://php.github.io/php-src/). It is in very early stages, but is +intended to become the primary place where new information about php-src is documented. Over time, +it is expected to replace various mediums like: * https://www.phpinternalsbook.com/ * https://wiki.php.net/internals @@ -21,7 +22,8 @@ That's it! You can view the documentation under `./build/html/index.html` in you ## Formatting -The files in this documentation are formatted using the [``rstfmt``](https://github.com/dzhu/rstfmt) tool. +The files in this documentation are formatted using the +[``rstfmt``](https://github.com/dzhu/rstfmt) tool. ```bash rstfmt -w 100 source