Skip to content

Commit

Permalink
Add release version to docs footer, Add doc build instructions (#963)
Browse files Browse the repository at this point in the history
* Add guide for building the docs

* Add version to the footer of the docs

* fix links for readme

* change formatting of doc build readme

* proper capitalization of DocFX in readme

* Remove code tags around version
  • Loading branch information
Chris-Johnston authored and foxbot committed Mar 24, 2018
1 parent 55299ff commit 88e6244
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
16 changes: 16 additions & 0 deletions docs/README.md
@@ -0,0 +1,16 @@
# Instructions for Building Documentation

The documentation for the Discord.NET library uses [DocFX][docfx-main]. [Instructions for installing this tool can be found here.][docfx-installing]

1. Navigate to the root of the repository.
2. (Optional) If you intend to target a specific version, ensure that you
have the correct version checked out.
3. Build the library. Run `dotnet build` in the root of this repository.
Ensure that the build passes without errors.
4. Build the docs using `docfx .\docs\docfx.json`. Add the `--serve` parameter
to preview the site locally. Some elements of the page may appear incorrect
when not hosted by a server.
- Remarks: According to the docfx website, this tool does work on Linux under mono.

[docfx-main]: https://dotnet.github.io/docfx/
[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
4 changes: 2 additions & 2 deletions docs/docfx.json
Expand Up @@ -67,8 +67,8 @@
"default"
],
"globalMetadata": {
"_appFooter": "Discord.Net (c) 2015-2017"
"_appFooter": "Discord.Net (c) 2015-2018 2.0.0-beta"
},
"noLangKeyword": false
}
}
}

0 comments on commit 88e6244

Please sign in to comment.