Skip to content

Commit 0cc144a

Browse files
committed
website fix small issues
1 parent a04609f commit 0cc144a

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

website/docs/getting-started/_project/_status.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The Doxygen replica site is publicly available in the [xpack/web-doxygen](https:
2121

2222
The [LLVM API reference](https://llvm.org/doxygen/) is another example of a site that has been successfully converted using **doxygen2docusaurus**.
2323

24-
Unfortunately, the site is exceptionally large (20,000+ pages, 1GB+), and Docusaurus does not handle such large sites effectively (builds require considerable time and memory consumption is very high), rendering it unsuitable as an exemplar for a Docusaurus site.
24+
Unfortunately, the site is exceptionally large (20,000+ pages, 1GB+), and Docusaurus does not handle such large sites effectively (builds require considerable time and memory consumption is very high), making it unsuitable as a demonstration for a Docusaurus site.
2525

2626
The LLVM replica site is publicly available in the [xpack/web-llvm](https://github.com/xpack/web-llvm) repository.
2727

website/docs/user/_project/_content.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The usual Docusaurus project structure uses a `website` subfolder:
3333
└── doxygen2docusaurus.json
3434
```
3535

36-
For typical projects, the Doxygen files may be located within the `website` folder. Should the project employ a custom procedure to generate the Doxygen pages, the converter must be configured to reference the custom folder utilised by that procedure.
36+
For typical projects, the Doxygen files may be located within the `website` folder. If the project uses a custom process to generate the Doxygen pages, the converter must be configured to reference the custom folder used by that process.
3737

3838
It is recommended to commit the `docs/api` folder (and potentially the `doxygen/xml` folder) to the repository, as this facilitates effective version control of the documentation alongside the project code.
3939

website/docs/user/configuration/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Default: `false`
165165

166166
Some Doxygen sites may include static pages. When using Docusaurus, these pages are usually migrated to docs pages, but if they are still present in the Doxygen XML files, the content can still be temporarily kept as such.
167167

168-
This boolean option controls if the pages are list in the sidebar at the top level.
168+
This boolean option controls if the pages are listed in the sidebar at the top level.
169169

170170
Default: `true`
171171

0 commit comments

Comments
 (0)