Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add hosted docs link to docs/README.md #13633

Closed
wants to merge 3 commits into from
+6 −4
Closed

Add hosted docs link to docs/README.md #13633

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
66e97d1
Add hosted docs link to docs/README.md
mvorisek Mar 8, 2024
0127ef1
address feedback
mvorisek Mar 8, 2024
54f2e42
fix strict 100 char line limit
mvorisek Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/README.md
View file
Open in desktop
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