Skip to content
This repository was archived by the owner on Jun 21, 2025. It is now read-only.

Commit 12829f1

Browse files
zabszkzabszk
committed
Docs fix
1 parent c719830 commit 12829f1

5 files changed

Lines changed: 47 additions & 17 deletions

File tree

‎NwPluginAPI.Docs/articles/intro.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# NwAPI Introduction
22

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

75
## [Getting Started](gettingstarted/gettingstarted.md)
8-
* ### [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
9-
* ### [Writing code](gettingstarted/gettingstarted.md#writing-the-code)
6+
* [Environment setup](gettingstarted/gettingstarted.md#environment-setup)
7+
* [Writing code](gettingstarted/gettingstarted.md#writing-the-code)
8+
109
## [Code Prerequisites](gettingstarted/codeprerequisites.md)
11-
* ### [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
12-
* ### [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
13-
* ### [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)
10+
* [The `Plugin` class](gettingstarted/codeprerequisites.md#the-plugin-class)
11+
* [The `Config` class](gettingstarted/codeprerequisites.md#the-config-class)
12+
* [Event handlers](gettingstarted/codeprerequisites.md#event-handlers)

‎NwPluginAPI.Docs/log.txt‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -970,3 +970,33 @@
970970
{"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"}
971971
{"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"}
972972
{"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"}
973+
{"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"}
974+
{"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"}
975+
{"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"}
976+
{"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"}
977+
{"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"}
978+
{"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"}
979+
{"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"}
980+
{"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"}
981+
{"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"}
982+
{"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"}
983+
{"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"}
984+
{"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"}
985+
{"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"}
986+
{"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"}
987+
{"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"}
988+
{"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"}
989+
{"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"}
990+
{"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"}
991+
{"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"}
992+
{"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"}
993+
{"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"}
994+
{"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"}
995+
{"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"}
996+
{"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"}
997+
{"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"}
998+
{"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"}
999+
{"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"}
1000+
{"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"}
1001+
{"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"}
1002+
{"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"}

‎docs/articles/intro.html‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,16 +92,17 @@ <h1 class="search-list">Search Results for <span></span></h1>
9292
<article class="content wrap" id="_content" data-uid="">
9393
<h1 id="nwapi-introduction">NwAPI Introduction</h1>
9494

95-
<p>TODO: IMPROVE INTRO</p>
9695
<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>
9796
<h2 id="getting-startedgettingstartedgettingstartedmd"><a href="gettingstarted/gettingstarted.html">Getting Started</a></h2>
9897
<ul>
99-
<li>### <a href="gettingstarted/gettingstarted.html#environment-setup">Environment setup</a></li>
100-
<li>### <a href="gettingstarted/gettingstarted.html#writing-the-code">Writing code</a>
101-
## <a href="gettingstarted/codeprerequisites.html">Code Prerequisites</a></li>
102-
<li>### <a href="gettingstarted/codeprerequisites.html#the-plugin-class">The <code>Plugin</code> class</a></li>
103-
<li>### <a href="gettingstarted/codeprerequisites.html#the-config-class">The <code>Config</code> class</a></li>
104-
<li>### <a href="gettingstarted/codeprerequisites.html#event-handlers">Event handlers</a></li>
98+
<li><a href="gettingstarted/gettingstarted.html#environment-setup">Environment setup</a></li>
99+
<li><a href="gettingstarted/gettingstarted.html#writing-the-code">Writing code</a></li>
100+
</ul>
101+
<h2 id="code-prerequisitesgettingstartedcodeprerequisitesmd"><a href="gettingstarted/codeprerequisites.html">Code Prerequisites</a></h2>
102+
<ul>
103+
<li><a href="gettingstarted/codeprerequisites.html#the-plugin-class">The <code>Plugin</code> class</a></li>
104+
<li><a href="gettingstarted/codeprerequisites.html#the-config-class">The <code>Config</code> class</a></li>
105+
<li><a href="gettingstarted/codeprerequisites.html#event-handlers">Event handlers</a></li>
105106
</ul>
106107
</article>
107108
</div>

‎docs/index.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"articles/intro.html": {
2828
"href": "articles/intro.html",
2929
"title": "NwAPI Introduction | Nw Plugin API",
30-
"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"
30+
"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"
3131
},
3232
"index.html": {
3333
"href": "index.html",

‎docs/manifest.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
"output": {
8282
".html": {
8383
"relative_path": "articles/intro.html",
84-
"hash": "RXvpib2PMefn1thS1RxQUQlw8Zx1B3Q3nQ97Rjw1Mfo="
84+
"hash": "Hj+H7JoH6V0FAAGP57/flRzCmll67dIR8lyeZiR4hqk="
8585
}
8686
},
8787
"is_incremental": false,
@@ -159,7 +159,7 @@
159159
"can_incremental": true,
160160
"incrementalPhase": "build",
161161
"total_file_count": 7,
162-
"skipped_file_count": 7
162+
"skipped_file_count": 6
163163
},
164164
"ResourceDocumentProcessor": {
165165
"can_incremental": false,

0 commit comments

Comments
 (0)