More automatic documentation build checks (Lombiq Technologies: OCORE-164) #15887
Conversation
| @@ -43,7 +43,7 @@ repo_url: https://github.com/OrchardCMS/OrchardCore | |||
| edit_uri: edit/main/src/ | |||
|
|
|||
| # Options | |||
| docs_dir: src | |||
| docs_dir: src/docs | |||
There was a problem hiding this comment.
This necessitates all the "docs/" removals. Now not the whole src folder is considered the docs site, making builds much faster too.
WalkthroughWalkthroughThe OrchardCore project underwent various updates aimed at refining documentation and navigation structures. Changes include adjusting project type declarations, modifying file paths in navigation, enhancing hyperlink references, and correcting URL casing. Content recommendations were also refined, such as the guidance on using PowerShell with MkDocs. These modifications collectively aim to enhance user experience, ensure accuracy, and maintain consistency in the documentation. Changes
This table groups similar changes and highlights key adjustments made to the OrchardCore documentation and configurations. Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (2)
Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (33)
src/docs/topics/search/README.md (1)
Line range hint
11-11: Add a hyphen to the compound adjective for clarity.- Full text search implementation + Full-text search implementationsrc/docs/topics/display/README.md (1)
Line range hint
12-12: Correct the syntax error by adding the missing closing bracket.- TBD [What is a shape?](https://github.com/OrchardCMS/OrchardCore/issues/1184) + TBD [What is a shape?](https://github.com/OrchardCMS/OrchardCore/issues/1184)src/docs/reference/modules/Resources/README.md (27)
Line range hint
1-1: Add a space after the period between "Resources" and "TheResourcesmodule".
Line range hint
5-5: Consider adding a comma before "so" as it connects two independent clauses.
Line range hint
11-11: Capitalize the first letter of the sentence starting with "Resourceswill be served via theStaticFileMiddleware".
Line range hint
11-11: Correct the spelling of "themes" to "theme's" to show possession.
Line range hint
12-12: Consider adding a comma after "folder" for clarity.
Line range hint
23-23: Correct the spelling of "or" to "of" in "EnablingAppendVersionor Resources cache busting".
Line range hint
37-37: Add a comma after "supplied" for better readability.
Line range hint
43-43: Add a space after the period between sentences.
Line range hint
107-107: Consider adding a comma after "Additionally" for better readability.
Line range hint
110-110: Use "an" instead of "a" before "unminified version".
Line range hint
111-111: Consider adding a comma after "ResourceDebugMode".
Line range hint
143-143: Capitalize the first letter of the sentence starting with "Make sure to register".
Line range hint
150-150: Consider adding a comma after "code" to separate the clauses more clearly.
Line range hint
154-154: Add a space after the period between sentences.
Line range hint
155-155: Add a space after the period between sentences.
Line range hint
183-183: Consider adding a comma after "3.5" for better readability.
Line range hint
221-221: Add a space after the period between sentences.
Line range hint
221-221: Add a space after the period between sentences.
Line range hint
255-255: Consider rephrasing to "By default, the behavior is defined by configuration."
Line range hint
304-304: Consider adding a comma after "Foot" for better readability.
Line range hint
366-366: Consider adding a comma after "bar" for better readability.
Line range hint
376-376: Capitalize the first letter of the sentence starting with "You do not have to define".
Line range hint
377-377: Consider adding a comma after "Hence" for better readability.
Line range hint
416-416: Consider adding an article before "Named script".
469-469: Consider adding a comma after "stylesheet" for better readability.
Line range hint
589-589: Consider adding a comma after "name" for better readability.
Line range hint
596-596: Capitalize the first letter of the sentence starting with "It is recommended".src/docs/community/contributors/README.md (4)
Line range hint
6-6: Consider adding a comma after the badge section for better readability.- <!-- ALL-CONTRIBUTORS-BADGE:END --> Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key))! + <!-- ALL-CONTRIBUTORS-BADGE:END -->, Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key))!
Line range hint
9-9: Start the sentence with an uppercase letter for consistency.- !!! info Do you want to become an Orchard Core contributor too? Awesome! Check out [our contribution guide](../../guides/contributing/README.md). + !!! Info Do you want to become an Orchard Core contributor too? Awesome! Check out [our contribution guide](../../guides/contributing/README.md).
Line range hint
482-482: Consider reducing the number of exclamation marks to maintain a professional tone.- Contributions of any kind welcome! + Contributions of any kind are welcome.
Line range hint
482-482: Ensure the file ends with a single newline character.Please add a newline at the end of the file to adhere to common coding standards.
There were some INFO console entries coming from the docs build, see e.g. here. This PR fixes those and with stricter validation makes the build check for more issues, preventing further mistakes. By configuring MkDocs to only consider the actual
src/docsfolder the docs site's folder, the docs site build is much faster too (most notably under Windows).