[web-doc] master: Resolve a typo, reword a statement
| From: | Tiffany via GitHub | Date: | Sat, 31 Jul 2021 20:40:55 +0000 |
| Subject: | [web-doc] master: Resolve a typo, reword a statement | ||
| Groups: | php.doc.web | ||
| Request: | Send a blank email to doc-web+get-2488@lists.php.net to get a copy of this message | ||
Author: Tiffany (tiffany-taylor)
Committer: GitHub (web-flow)
Pusher: tiffany-taylor
Date: 2021-07-31T15:41:20-05:00
Commit: https://github.com/php/web-doc/commit/591edb2c8fd190fed29b52c4b44e4c80ee11d9f0
Raw diff: https://github.com/php/web-doc/commit/591edb2c8fd190fed29b52c4b44e4c80ee11d9f0.diff
Resolve a typo, reword a statement
Changed paths:
M tutorial/local-setup.md
Diff:
diff --git a/tutorial/local-setup.md b/tutorial/local-setup.md
index d8089dd..34e2b03 100644
--- a/tutorial/local-setup.md
+++ b/tutorial/local-setup.md
@@ -31,7 +31,7 @@ $ git clone https://github.com/php/doc-base.git
```
$ php doc-base/configure.php
```
-Running
configure.php will run check and verify that the changes made to the XML
validate with Docbook specification. If you receive an error message: resolve the error message and
try running the configure.php script again. If you see an ASCII cat, your XML is valid.
+Running configure.php will check and validate the XML according to the Docbook
specification. If you receive an error message: resolve the error message and try running the
configure.php script again. If you see an ASCII cat, your XML is valid.
## Build the documentation
We use PhD to build the documentation. It takes the source that configure.php
generates, and builds
@@ -45,7 +45,7 @@ $ php phd/render.php --help
```
### Use PhD to build the documentation
-As previously stated, there are multiple formats PhD can build the docs, but the two most commonly
used for checking changes are XHTML and PHP. Building the docs into PHP requires a web server to
view the pages, whereas XHTML does not. For small changes, for example, affects only one page,
building docs into XHTML is likely preferable.
+As previously stated, there are multiple formats PhD can build the docs, but the two most commonly
used for checking changes are XHTML and PHP. Building the docs into PHP requires a web server to
view the pages, whereas XHTML does not. For small changes, building docs into XHTML is likely
preferable. An example of a small change is modifying one file.
```
$ php doc-base/configure.php
$ php phd/render.php --docbook doc-base/.manual.xml --package PHP --format xhtml