Skip to content

Commit

Permalink
Docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@zabszk
zabszk committed Dec 20, 2022
1 parent c719830 commit 12829f1
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 17 deletions.
13 changes: 6 additions & 7 deletions NwPluginAPI.Docs/articles/intro.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# NwAPI Introduction

TODO: IMPROVE INTRO

The Northwood plugin API (NWAPI) is a first-party, event based API used to create server-side plugins for SCP:SL in C#.

## [Getting Started](gettingstarted/gettingstarted.md)
* ### [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
* ### [Writing code](gettingstarted/gettingstarted.md#writing-the-code)
* [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
* [Writing code](gettingstarted/gettingstarted.md#writing-the-code)

## [Code Prerequisites](gettingstarted/codeprerequisites.md)
* ### [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
* ### [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
* ### [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)
* [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
* [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
* [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)
30 changes: 30 additions & 0 deletions NwPluginAPI.Docs/log.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -970,3 +970,33 @@
{"message":"Invalid link: '<a href=\"articles/gettingstarted/codeprerequisites.md#event-handlers\">Event handlers</a>'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/toc.md","date_time":"2022-12-20T18:05:20.7497979Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"1E587945-9738-4D1E-91FE-498A92FE5A52.2.198.1.3.1.21.2"}
{"message":"Invalid link: '[The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'the-config-class'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"12","date_time":"2022-12-20T18:05:20.7497979Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"1E587945-9738-4D1E-91FE-498A92FE5A52.2.198.1.3.1.21.3"}
{"message":"Invalid link: '[Event handlers](gettingstarted/codeprerequisites.md#event-handlers)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"13","date_time":"2022-12-20T18:05:20.7497979Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"1E587945-9738-4D1E-91FE-498A92FE5A52.2.198.1.3.1.21.4"}
{"message":"Unable to find either toc.yml or toc.md inside obj/api/. Make sure the file is included in config file docfx.json!","source":"BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor.Prebuild.BuildTocDocument","file":"toc.yml","date_time":"2022-12-20T18:09:16.0699766Z","message_severity":"warning","correlation_id":"A78EAE91-DB86-4F66-A176-66C035542C00.2.197.1.31.9.3.2.1"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNETFramework48.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7534804Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDManageNuget.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNugetInstall.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNorthwoodPluginApi.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSClassLib.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDCreateNewMenu.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDClassLib.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSManageNuget.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSCreateNewMenu.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDNorthwoodPluginApi.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:09:17.7544576Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid link: '[The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'the-config-class'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"13","date_time":"2022-12-20T18:09:17.9752146Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"A78EAE91-DB86-4F66-A176-66C035542C00.2.198.1.3.1.21.1"}
{"message":"Invalid link: '[Event handlers](gettingstarted/codeprerequisites.md#event-handlers)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"14","date_time":"2022-12-20T18:09:17.9752146Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"A78EAE91-DB86-4F66-A176-66C035542C00.2.198.1.3.1.21.2"}
{"message":"Invalid link: '<a href=\"articles/gettingstarted/codeprerequisites.md#the-config-class\">The `Config` class</a>'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'the-config-class'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/toc.md","date_time":"2022-12-20T18:09:17.9752146Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"A78EAE91-DB86-4F66-A176-66C035542C00.2.198.1.3.1.21.3"}
{"message":"Invalid link: '<a href=\"articles/gettingstarted/codeprerequisites.md#event-handlers\">Event handlers</a>'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/toc.md","date_time":"2022-12-20T18:09:17.9752146Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"A78EAE91-DB86-4F66-A176-66C035542C00.2.198.1.3.1.21.4"}
{"message":"Unable to find either toc.yml or toc.md inside obj/api/. Make sure the file is included in config file docfx.json!","source":"BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor.Prebuild.BuildTocDocument","file":"toc.yml","date_time":"2022-12-20T18:12:29.4505861Z","message_severity":"warning","correlation_id":"61BF7A79-EF9C-4913-AEB8-01FDE04FB6B8.2.197.1.31.9.3.2.1"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNETFramework48.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0753035Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDManageNuget.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0753035Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNugetInstall.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSNorthwoodPluginApi.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSClassLib.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDCreateNewMenu.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDClassLib.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSManageNuget.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/VSCreateNewMenu.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid file link:(~/articles/gettingstarted/RDNorthwoodPluginApi.png).","source":"BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save","file":"articles/gettingstarted/gettingstarted-ide.md","line":"0","date_time":"2022-12-20T18:12:31.0763009Z","message_severity":"warning","code":"InvalidFileLink"}
{"message":"Invalid link: '[The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'the-config-class'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"11","date_time":"2022-12-20T18:12:31.3153531Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"61BF7A79-EF9C-4913-AEB8-01FDE04FB6B8.2.198.1.3.1.21.1"}
{"message":"Invalid link: '[Event handlers](gettingstarted/codeprerequisites.md#event-handlers)'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/intro.md","line":"12","date_time":"2022-12-20T18:12:31.3153531Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"61BF7A79-EF9C-4913-AEB8-01FDE04FB6B8.2.198.1.3.1.21.2"}
{"message":"Invalid link: '<a href=\"articles/gettingstarted/codeprerequisites.md#the-config-class\">The `Config` class</a>'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'the-config-class'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/toc.md","date_time":"2022-12-20T18:12:31.3153531Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"61BF7A79-EF9C-4913-AEB8-01FDE04FB6B8.2.198.1.3.1.21.3"}
{"message":"Invalid link: '<a href=\"articles/gettingstarted/codeprerequisites.md#event-handlers\">Event handlers</a>'. The file articles/gettingstarted/codeprerequisites.md doesn't contain a bookmark named 'event-handlers'.","source":"BuildCommand.Postprocess.HandlePostProcessorsWithIncremental.HandlePostProcessors.Processing html.ValidateBookmark","file":"articles/toc.md","date_time":"2022-12-20T18:12:31.3153531Z","message_severity":"warning","code":"InvalidBookmark","correlation_id":"61BF7A79-EF9C-4913-AEB8-01FDE04FB6B8.2.198.1.3.1.21.4"}
15 changes: 8 additions & 7 deletions docs/articles/intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,17 @@ <h1 class="search-list">Search Results for <span></span></h1>
<article class="content wrap" id="_content" data-uid="">
<h1 id="nwapi-introduction">NwAPI Introduction</h1>

<p>TODO: IMPROVE INTRO</p>
<p>The Northwood plugin API (NWAPI) is a first-party, event based API used to create server-side plugins for SCP:SL in C#.</p>
<h2 id="getting-startedgettingstartedgettingstartedmd"><a href="gettingstarted/gettingstarted.html">Getting Started</a></h2>
<ul>
<li>### <a href="gettingstarted/gettingstarted.html#environment-setup">Environment setup</a></li>
<li>### <a href="gettingstarted/gettingstarted.html#writing-the-code">Writing code</a>
## <a href="gettingstarted/codeprerequisites.html">Code Prerequisites</a></li>
<li>### <a href="gettingstarted/codeprerequisites.html#the-plugin-class">The <code>Plugin</code> class</a></li>
<li>### <a href="gettingstarted/codeprerequisites.html#the-config-class">The <code>Config</code> class</a></li>
<li>### <a href="gettingstarted/codeprerequisites.html#event-handlers">Event handlers</a></li>
<li><a href="gettingstarted/gettingstarted.html#environment-setup">Environment setup</a></li>
<li><a href="gettingstarted/gettingstarted.html#writing-the-code">Writing code</a></li>
</ul>
<h2 id="code-prerequisitesgettingstartedcodeprerequisitesmd"><a href="gettingstarted/codeprerequisites.html">Code Prerequisites</a></h2>
<ul>
<li><a href="gettingstarted/codeprerequisites.html#the-plugin-class">The <code>Plugin</code> class</a></li>
<li><a href="gettingstarted/codeprerequisites.html#the-config-class">The <code>Config</code> class</a></li>
<li><a href="gettingstarted/codeprerequisites.html#event-handlers">Event handlers</a></li>
</ul>
</article>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"articles/intro.html": {
"href": "articles/intro.html",
"title": "NwAPI Introduction | Nw Plugin API",
"keywords": "NwAPI Introduction TODO: IMPROVE INTRO The Northwood plugin API (NWAPI) is a first-party, event based API used to create server-side plugins for SCP:SL in C#. Getting Started ### Environment setup ### Writing code ## Code Prerequisites ### The Plugin class ### The Config class ### Event handlers"
"keywords": "NwAPI Introduction The Northwood plugin API (NWAPI) is a first-party, event based API used to create server-side plugins for SCP:SL in C#. Getting Started Environment setup Writing code Code Prerequisites The Plugin class The Config class Event handlers"
},
"index.html": {
"href": "index.html",
Expand Down
4 changes: 2 additions & 2 deletions docs/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
"output": {
".html": {
"relative_path": "articles/intro.html",
"hash": "RXvpib2PMefn1thS1RxQUQlw8Zx1B3Q3nQ97Rjw1Mfo="
"hash": "Hj+H7JoH6V0FAAGP57/flRzCmll67dIR8lyeZiR4hqk="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -159,7 +159,7 @@
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 7,
"skipped_file_count": 7
"skipped_file_count": 6
},
"ResourceDocumentProcessor": {
"can_incremental": false,
Expand Down

0 comments on commit 12829f1

Please sign in to comment.