From 66e97d144a223e99b91c1615da64bfb53f666d18 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 1/3] Add hosted docs link to docs/README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index b845375c30933..8636c13bf9b34 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # php-src docs -This is the home of the php-src internal documentation. It is in very early stages, but is intended +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: From 0127ef18f1731d6ebadd23b7aacb6febc6a5e03a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vo=C5=99=C3=AD=C5=A1ek?= Date: Fri, 8 Mar 2024 12:36:58 +0100 Subject: [PATCH 2/3] address feedback --- docs/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 8636c13bf9b34..d1fb4c7c043f5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,7 @@ # php-src docs -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 +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: From 54f2e4282bcc5c1df83660fe32aee7d7769bbcb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vo=C5=99=C3=AD=C5=A1ek?= Date: Fri, 8 Mar 2024 12:50:07 +0100 Subject: [PATCH 3/3] fix strict 100 char line limit --- docs/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index d1fb4c7c043f5..953eb2ab08e0f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,9 @@ # php-src docs 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: +[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 @@ -22,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