clones/php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2024-09-21 01:47:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add hosted docs link to docs/README.md

Browse Source 
Closes GH-13633
This commit is contained in:
Michael Voříšek 2024-03-08 11:31:25 +01:00 committed by Ilija Tovilo
parent 540e37fd44
commit c412919c93
No known key found for this signature in database
GPG Key ID: A4F5D403F118200A
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/README.md
View File

@ -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