RussellSpitzer commented on code in PR #8919:
URL: https://github.com/apache/iceberg/pull/8919#discussion_r1391561630


##########
site/README.md:
##########
@@ -35,107 +35,101 @@ In MkDocs, the 
[`docs_dir`](https://www.mkdocs.org/user-guide/configuration/#doc
 
 ### Iceberg docs layout
 
-In the Iceberg docs, since the top-level site and versioned docs are contained 
in the same directory, they all live under the `/site` directory of the main 
Iceberg repository. The `/site/docs` directory is named this way to follow the 
[MkDocs convention](https://www.mkdocs.org/user-guide/configuration/#docs_dir), 
while the `/site/docs/docs` directory is an analog to the "Docs" navigation 
tab. Under this directory, you'll find the `/site/docs/docs/nightly` directory, 
which contains the state of the documentation in the local revisions.
+The static Iceberg website and versioned documentation live together under the 
`/site` directory of the main Iceberg repository. The `/site/docs` directory is 
named that way to follow the [MkDocs 
convention](https://www.mkdocs.org/user-guide/configuration/#docs_dir), while 
the nested `/site/docs/docs` directory is an analog to the "Docs" navigation 
tab. The `/site/docs/nightly` directory contains the current state of the 
versioned documentation with local revisions.

Review Comment:
   minor nit: "directory is named that way to follow the" => "is named 
following the"



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org

Reply via email to