Skip to content

Commit

Permalink
Add hosted docs link to docs/README.md
Browse files Browse the repository at this point in the history
Closes GH-13633
  • Loading branch information
mvorisek authored and iluuu1994 committed Mar 8, 2024
1 parent 540e37f commit c412919
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down

0 comments on commit c412919

Please sign in to comment.