Reviving old Nitrocid Documentation
While we are gathering information about how we plan to finalize the documentation for the upcoming Nitrocid release, we’ve discovered an interesting way to revive the old Nitrocid documentation. Before we get into details into how we did it, here’s some background information about the original Nitrocid documentation.
When version 0.0.6 was still in development, we did it as part of the executable using embedded resources. You can see the resultant “manual page” files here, before the migration to GitHub Wiki started at around 2019 before the release of 0.0.8. The documentation then stayed on GitHub Wiki until 2022, when we had planned to move the docs to DocFX during the development of 0.0.23.x.
However, during development of 0.0.24.x, we’ve discovered that the documentation needed a rework, and that libraries at the time had no documentation. The only documentation that was provided at the time was the API docs, and that, in our opinion, wasn’t enough, because the API docs don’t usually provide detailed information about the functionality of the library.
So, when 2023 started, we’ve begun a project that focuses on a complete rewrite of the Nitrocid documentation, which was part of our plan of the Nitrocid 0.1.0 release. During the beta release, we’ve brought the GitBook documentation online. That was after careful choosing of the documentation frameworks: whether to continue using DocFX or to switch to another doc framework (GitBook, Read The Docs, etc.) was our question.
Modernity of our docs and simplification of our workflow was our requirements, and GitBook has been carefully chosen after considering its capabilities. The current GitBook documentation can be found here. This migration has caused us to shut down the Wiki section in our GitHub as we were telling people that the migration was done.
Fast forward to today, as we no longer have backups of the old wiki for versions 0.0.23.x and older, we’ve decided to run a Git clone on the Wiki repository of Nitrocid to check to see if we can fetch them. Here’s the command:
$ git clone https://github.com/Aptivi/Nitrocid.wiki.git
Instead of getting an error or getting an empty repository, we got a full history of the wiki that was active from 2019 to 2022. This gave us a brand new project to do during the “Final Touches” stage of 0.2.0 as part of the documentation preservation project under the Archived Manuals GitHub organization, making February 12th the biggest milestone yet.
We will study the structure of the commits and release archived documentation under GitBook when each version is discovered. This release is going to be asynchronous to the 0.2.0 release plan.
We have learned that when you disable the Wiki on GitHub, the repository that contains the wiki itself won’t be deleted. For example, deactivating Nitrocid’s Wiki section on GitHub won’t remove the Nitrocid.wiki.git repository. Therefore, this is done on purpose to make restoration easier, in case you ever want to turn the Wiki section back on.
To clone the wiki repository when the Wiki section is disabled, just run this command:
$ git clone https://github.com/<owner>/<repo>.wiki.git
You can interact with it just like any other Git repository.
#docs #documentation #gitbook #KernelSimulator #KS #NKS #news #nitrocid #NitrocidKS #Tech #Technology #update