github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve new docs site. (#2843)

Browse Source 
* Improve parameter padding and add discord link.

* Update xref service for docs.

Reason: https://github.com/dotnet/docfx/issues/9659

* Update docs readme to specify docfx version.

* Update to latest DocFX.

* update action & add manual trigger
This commit is contained in:
Nora
2024-02-13 19:30:22 +01:00
committed by GitHub
parent a1987021fe
commit 61ba44cdce
6 changed files with 23 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@@ -3,13 +3,15 @@
The documentation for the Discord.Net library uses [DocFX][docfx-main].
Instructions for installing this tool can be found [here][docfx-installing].
> [!IMPORTANT]
> You must use DocFX version **2.75.2** for everything to work.
1. Navigate to the root of the repository.
2. Build the docs using `docfx docs/docfx.json`. Add the `--serve`
parameter to preview the site locally. Some elements of the page
may appear incorrectly when hosted offline.
parameter to preview the site locally.
Please note that if you intend to target a specific version, ensure
that you have the correct version checked out.
[docfx-main]: https://dotnet.github.io/docfx/
[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
[docfx-installing]: https://dotnet.github.io/docfx/index.html