Docs Update (#41)

* Updated superscript for docs as DOCFX doesn't support the common markdown extension for it.
* Removed unused markdown file
* Updated template readme for clarity.
* Updated doc comments for `DateTimeExtensions.ToBuildIndex` for clarity

Co-authored-by: smaillet <[email protected]>

Author: smaillet

docfx/build-tasks/index.md

@@ -239,7 +239,7 @@ section of this document.
 | CSM103 | PreReleaseName is unknown |
 | CSM104 | PreReleaseNumber value must be in range [0-99] |
 | CSM105 | PreReleaseFix value must be in range [0-99] |
-| CSM106^1^ | If CiBuildIndex is set then CiBuildName must also be set; If CiBuildIndex is NOT set then CiBuildName must not be set. |
+| CSM106<sup>1</sup> | If CiBuildIndex is set then CiBuildName must also be set; If CiBuildIndex is NOT set then CiBuildName must not be set. |
 | CSM107 | CiBuildIndex does not match syntax defined by CSemVer |
 | CSM108 | CiBuildName does not match syntax defined by CSemVer |
 
@@ -253,7 +253,7 @@ section of this document.
 | CSM204 | XML format of file specified by `$(BuildVersionXml)' is invalid |
 
 ----
-^1^ CSM106 is essentially an internal sanity test. The props/targets files ensure that
+<sup>1</sup> CSM106 is essentially an internal sanity test. The props/targets files ensure that
 `$(CiBuildIndex)` and `$(CiBuildName)` have a value unless $(IsReleaseBuild) is set. In that case
 the targets file will force them to empty. So, there's no way to test for or hit this condition
 without completely replacing/bypassing the props/targets files for the task. Which is obviously,

docfx/documentation.msbuildproj

@@ -17,7 +17,6 @@
     <!--Everything in the versioning-lib sub-folder except the API folder as that contains generated files -->
     <None Include="versioning-lib/**" Exclude="versioning-lib/api/**" />
     <!-- Explicitly call out the non-generated files in the API folder-->
-    <None Include="versioning-lib/api/index.md" />
     <None Include="versioning-lib/api/.gitignore" />
   </ItemGroup>
   <ItemGroup>

docfx/templates/Ubiquity/readme.md

@@ -1,4 +1,5 @@
 # Ubiquity DOCFX template
-This template adds support to the modern template to disable some features like inherited members. It
-would be nice if docfx didn't even generate such things, but it has non knobs to control that so it can
-only be disabled by a custom CSS to hide the content at page render time on the client...
+This template adds support to the modern template to disable some features like inherited
+members. It would be nice if docfx didn't even generate such things, but it has no knobs to
+control that so it can only be disabled by a custom CSS to hide the content at page render
+time on the client...

docfx/versioning-lib/api/index.md

@@ -22,8 +22,8 @@ public static class DateTimeExtensions
         /// Since the resulting build index is based on the number of seconds since midnight and needs
         /// to fit in a limited string output. There is a narrow window of 2 seconds where two distinct
         /// builds (Local or PR) might generate the same matching build number. However, since this number
-        /// is only used for local builds that's not realistically a problem. (Automated builds use the
-        /// commit hash of the repo as the build index)
+        /// is normally only used for local builds that's not realistically a problem. (Automated builds
+        /// usually use the time stamp of the HEAD commit of the repo as the build index)
         /// </remarks>
         public static string ToBuildIndex( this DateTime timeStamp )
         {