#gitbook — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #gitbook, aggregated by home.social.
-
#WordPress-based #BetterDocs is the most popular #documentation platform, just ahead of #GitBook and #docusaurus
https://w3techs.com/technologies/subdetails/documentation -
#WordPress-based #BetterDocs is the most popular #documentation platform, just ahead of #GitBook and #docusaurus
https://w3techs.com/technologies/subdetails/documentation -
New design for Aptivi Newsroom and API docs available!
Aptivi Newsroom was established this year to provide you with the latest news about our projects, while the API documentation sites provide you with automatically-generated API references for our C# projects.
We are very excited to announce that the new design for both the Aptivi Newsroom website and the API documentation site is now available! This plan was an extension to the redesign project of the Aptivi Blog that was done earlier.
We are showcasing the changed design for both mobile devices and for computer users in the below pictures to demonstrate the changes that were made to our sites:
To learn more about this change, please consult the Aptivi Newsroom article below.
Learn more #API #APIDocs #Aptivi #AptiviNewsroom #gitbook #news #Newsroom #Tech #Technology #update -
New design for Aptivi Newsroom and API docs available!
Aptivi Newsroom was established this year to provide you with the latest news about our projects, while the API documentation sites provide you with automatically-generated API references for our C# projects.
We are very excited to announce that the new design for both the Aptivi Newsroom website and the API documentation site is now available! This plan was an extension to the redesign project of the Aptivi Blog that was done earlier.
We are showcasing the changed design for both mobile devices and for computer users in the below pictures to demonstrate the changes that were made to our sites:
To learn more about this change, please consult the Aptivi Newsroom article below.
Learn more #API #APIDocs #Aptivi #AptiviNewsroom #gitbook #news #Newsroom #Tech #Technology #update -
Migration of Aptivi GitBook docs repos is now finished!
Yesterday, we announced that the migration of the documentation repositories for our GitBook docs was underway, and that we planned to start the migration as of today. The plan was outlined in a recent Aptivi Newsroom article that was published, which involved creating branches for every version and version series for all our projects.
Now, we are very excited to announce the finalization of the repository migration! As of today, we have migrated the following repositories to a single, central repository for every project:
- Terminaux
terminaux-manual-8.xterminaux-manual-7.xterminaux-manual-6.x
- BassBoom
bassboom-1.0.x-manual
- Nitrocid KS
nks-manual-0.1.0-rtmnks-manual-0.1.0-sp1nks-manual-0.1.0-sp2nks-manual-0.1.0-sp3nks-manual-0.1.0-sp4nks-manual-0.1.0-sp5nks-manual-0.1.0-sp6nks-manual-0.1.0-sp7nks-manual-0.2.0-rtmnks-manual-0.2.0-sp1
The above repositories have been condensed and consolidated to a single repository, which hosts multiple branches for every release. For example, Nitrocid 0.2.0 SP1’s documentation source can now be found here (branch name is
x/stable/v0.2.0-sp1), a derivation of thex/rolling/v0.2.0.xbranch you can see here.This migration was necessary as it makes it easier for us to create branches out of a current rolling documentation, in case there is a need for it, such as releasing Nitrocid v0.2.0 Service Pack 2, which is expected to be released around September 2026. This will eliminate overhead when setting up new repositories for each version, as it saves time.
If you are interested about the plan we’ve written earlier, consult the below Aptivi Newsroom article.
Learn more #Aptivi #gitbook #news #Tech #Technology #update - Terminaux
-
Migration of Aptivi GitBook docs repos is now finished!
Yesterday, we announced that the migration of the documentation repositories for our GitBook docs was underway, and that we planned to start the migration as of today. The plan was outlined in a recent Aptivi Newsroom article that was published, which involved creating branches for every version and version series for all our projects.
Now, we are very excited to announce the finalization of the repository migration! As of today, we have migrated the following repositories to a single, central repository for every project:
- Terminaux
terminaux-manual-8.xterminaux-manual-7.xterminaux-manual-6.x
- BassBoom
bassboom-1.0.x-manual
- Nitrocid KS
nks-manual-0.1.0-rtmnks-manual-0.1.0-sp1nks-manual-0.1.0-sp2nks-manual-0.1.0-sp3nks-manual-0.1.0-sp4nks-manual-0.1.0-sp5nks-manual-0.1.0-sp6nks-manual-0.1.0-sp7nks-manual-0.2.0-rtmnks-manual-0.2.0-sp1
The above repositories have been condensed and consolidated to a single repository, which hosts multiple branches for every release. For example, Nitrocid 0.2.0 SP1’s documentation source can now be found here (branch name is
x/stable/v0.2.0-sp1), a derivation of thex/rolling/v0.2.0.xbranch you can see here.This migration was necessary as it makes it easier for us to create branches out of a current rolling documentation, in case there is a need for it, such as releasing Nitrocid v0.2.0 Service Pack 2, which is expected to be released around September 2026. This will eliminate overhead when setting up new repositories for each version, as it saves time.
If you are interested about the plan we’ve written earlier, consult the below Aptivi Newsroom article.
Learn more #Aptivi #gitbook #news #Tech #Technology #update - Terminaux
-
Migration of Aptivi Docs and Stable Docs organizations in GitHub is underway!
#Aptivi #GitBook #Docs #Documentation #website #TechNews #TechUpdates #GitHub
-
Migration of Aptivi Docs and Stable Docs organizations in GitHub is underway!
#Aptivi #GitBook #Docs #Documentation #website #TechNews #TechUpdates #GitHub
-
Migrating Aptivi Docs and Stable Docs GitHub organizations
Currently, we are planning to make our GitBook documentation repositories easier to manage than before. This is going to make sure that future contributions to the GitBook documentation will come from only one repository for every project. In the current state, different versions have their own separate repositories, but we were experimenting documentation branches with Terminaux 8.x version series, and our experiments have been proven successful.
We are excited to announce that we will be migrating our GitBook documentation repositories from the Stable Docs organization with the related repositories from the Docs organization, ensuring that future contributions will go smoother than before.
Any links that point to all repositories that are found in the Stable Docs organization need to be updated, as there won’t be any redirection to be set up. This means that old links will break and will have to be updated.
To learn more about this change, visit the Aptivi Newsroom.
Learn more #documentation #gitbook #news #Tech #Technology #update -
Migrating Aptivi Docs and Stable Docs GitHub organizations
Currently, we are planning to make our GitBook documentation repositories easier to manage than before. This is going to make sure that future contributions to the GitBook documentation will come from only one repository for every project. In the current state, different versions have their own separate repositories, but we were experimenting documentation branches with Terminaux 8.x version series, and our experiments have been proven successful.
We are excited to announce that we will be migrating our GitBook documentation repositories from the Stable Docs organization with the related repositories from the Docs organization, ensuring that future contributions will go smoother than before.
Any links that point to all repositories that are found in the Stable Docs organization need to be updated, as there won’t be any redirection to be set up. This means that old links will break and will have to be updated.
To learn more about this change, visit the Aptivi Newsroom.
Learn more #documentation #gitbook #news #Tech #Technology #update -
I Bypassed Adobe and Microsoft to Build a Git-Tracked Book Production Pipeline
#HackerNews #GitBook #Pipeline #Adobe #Microsoft #Development
-
I Bypassed Adobe and Microsoft to Build a Git-Tracked Book Production Pipeline
#HackerNews #GitBook #Pipeline #Adobe #Microsoft #Development
-
Как мы потеряли GitBook за 5 минут и нашли Gramax — open-source альтернативу, которую теперь используем сами
Один клик — и ваша документация может исчезнуть. Именно так и произошло с нами. Поэтому мы нашли open-source альтернативу, где данными владеем только мы — и никакой регион это не изменит.
https://habr.com/ru/articles/1019230/
#Gramax #GitBook #open_source #документация #docsascode #Markdown #Git #стартап #альтернатива_GitBook #командная_документация
-
The new look for Aptivi documentation is now live! 🎉
#GitBook #Website #TechNews #TechUpdates #Aptivi #Documentation #csharp #programming #dotnet
https://officialaptivi.wordpress.com/2026/02/17/rollout-of-the-new-docs-look-is-done/
-
The new look for Aptivi documentation is now live! 🎉
#GitBook #Website #TechNews #TechUpdates #Aptivi #Documentation #csharp #programming #dotnet
https://officialaptivi.wordpress.com/2026/02/17/rollout-of-the-new-docs-look-is-done/
-
Rollout of the new docs look is done!
We have earlier stated the full freshening plan for all project documentation when it comes to projects, together with the rollout plan for this improvement. This improvement includes a new documentation look, which will make the docs easier to read with condensed sections, improved appearance, and more.
Now, we are very excited to announce the availability of the new look of docs for all projects!
The whole plan is now complete, but that doesn’t mean that this is the end of improvements; this is just the beginning, and improvements will be endless as we evaluate our docs and make them more fresh.
The new documentation look is now live on the official docs website, which you can access here.
Open the Aptivi Docs #docs #documentation #gitbook #github #news #Tech #Technology #update -
Rollout of the new docs look is done!
We have earlier stated the full freshening plan for all project documentation when it comes to projects, together with the rollout plan for this improvement. This improvement includes a new documentation look, which will make the docs easier to read with condensed sections, improved appearance, and more.
Now, we are very excited to announce the availability of the new look of docs for all projects!
The whole plan is now complete, but that doesn’t mean that this is the end of improvements; this is just the beginning, and improvements will be endless as we evaluate our docs and make them more fresh.
The new documentation look is now live on the official docs website, which you can access here.
Open the Aptivi Docs #docs #documentation #gitbook #github #news #Tech #Technology #update -
🎉 We have made all revived docs from Nitrocid 0.0.6 to 0.0.23 available on GitBook! 🎉
#GitBook #docs #Nitrocid #NitrocidKS #KernelSimulator #TechNews #TechUpdates #csharp #programming #dotnet #Aptivi
https://officialaptivi.wordpress.com/2026/02/12/nitrocids-old-revived-docs-are-now-available/
-
🎉 We have made all revived docs from Nitrocid 0.0.6 to 0.0.23 available on GitBook! 🎉
#GitBook #docs #Nitrocid #NitrocidKS #KernelSimulator #TechNews #TechUpdates #csharp #programming #dotnet #Aptivi
https://officialaptivi.wordpress.com/2026/02/12/nitrocids-old-revived-docs-are-now-available/
-
Nitrocid’s old revived docs are now available!
We’ve just released Nitrocid 0.2.0 as part of the huge milestone today, alongside the branding kit. But, there is still more for this huge milestone!
The biggest thing has happened since the history of Nitrocid! We’ve managed to revive the old documentation of Nitrocid from version 0.0.6 to 0.0.23, which were released from 2019 to 2022. Now, the docs for those versions are now available in our GitBook instance!
Our excitement has reached the top, and this has got to be the biggest and the greatest preservation plan we’ve ever planned in the history of Nitrocid!
In our GitBook documentation, the following versions are now available:
- 0.0.6.x: June 19th, 2019
- 0.0.7.x: August 30th, 2019
- 0.0.8 RC1: January 16th, 2020
- 0.0.8 RC2: February 1st, 2020
- 0.0.8 RC3: February 11th, 2020
- 0.0.8.x: February 22nd, 2020
- 0.0.9.x: April 23rd, 2020
- 0.0.10.x: May 19th, 2020
- 0.0.11.x: July 25th, 2020
- 0.0.12.x: November 6th, 2020
- 0.0.13.x: December 20th, 2020
- 0.0.14.x: January 21st, 2021
- 0.0.15.x: February 22nd, 2021
- 0.0.16.x: June 12th, 2021
- 0.0.17.x: July 4th, 2021
- 0.0.18.x: August 2nd, 2021
- 0.0.19.x: August 24th, 2021
- 0.0.20.x: February 22nd, 2022
- 0.0.21.x: April 28th, 2022
- 0.0.22.x: June 12th, 2022
- 0.0.23.x: July 12th, 2022
When we’ve released their documentation as part of the preservation project, we’ve preserved the history of how Nitrocid was documented when we first introduced it. It went from being a “booklet” for the project to a huge library of documentation, and most of the work traced back to our plan to refine the documentation for the first beta of 0.1.0 released on February 2023!
You can now take a look at the list of obsolete Nitrocid manuals by pressing the below button:
Open GitBook Docs #docs #documentation #gitbook #news #nitrocid #Tech #Technology #update -
Nitrocid’s old revived docs are now available!
We’ve just released Nitrocid 0.2.0 as part of the huge milestone today, alongside the branding kit. But, there is still more for this huge milestone!
The biggest thing has happened since the history of Nitrocid! We’ve managed to revive the old documentation of Nitrocid from version 0.0.6 to 0.0.23, which were released from 2019 to 2022. Now, the docs for those versions are now available in our GitBook instance!
Our excitement has reached the top, and this has got to be the biggest and the greatest preservation plan we’ve ever planned in the history of Nitrocid!
In our GitBook documentation, the following versions are now available:
- 0.0.6.x: June 19th, 2019
- 0.0.7.x: August 30th, 2019
- 0.0.8 RC1: January 16th, 2020
- 0.0.8 RC2: February 1st, 2020
- 0.0.8 RC3: February 11th, 2020
- 0.0.8.x: February 22nd, 2020
- 0.0.9.x: April 23rd, 2020
- 0.0.10.x: May 19th, 2020
- 0.0.11.x: July 25th, 2020
- 0.0.12.x: November 6th, 2020
- 0.0.13.x: December 20th, 2020
- 0.0.14.x: January 21st, 2021
- 0.0.15.x: February 22nd, 2021
- 0.0.16.x: June 12th, 2021
- 0.0.17.x: July 4th, 2021
- 0.0.18.x: August 2nd, 2021
- 0.0.19.x: August 24th, 2021
- 0.0.20.x: February 22nd, 2022
- 0.0.21.x: April 28th, 2022
- 0.0.22.x: June 12th, 2022
- 0.0.23.x: July 12th, 2022
When we’ve released their documentation as part of the preservation project, we’ve preserved the history of how Nitrocid was documented when we first introduced it. It went from being a “booklet” for the project to a huge library of documentation, and most of the work traced back to our plan to refine the documentation for the first beta of 0.1.0 released on February 2023!
You can now take a look at the list of obsolete Nitrocid manuals by pressing the below button:
Open GitBook Docs #docs #documentation #gitbook #news #nitrocid #Tech #Technology #update -
The GitBook documentation for our projects will be easier to navigate!
#GitBook #Website #Docs #TechNews #TechUpdates #Nitrocid #Terminaux #dotnet #csharp #programming
https://officialaptivi.wordpress.com/2026/02/06/the-documentation-will-be-easier-to-navigate/
-
The GitBook documentation for our projects will be easier to navigate!
#GitBook #Website #Docs #TechNews #TechUpdates #Nitrocid #Terminaux #dotnet #csharp #programming
https://officialaptivi.wordpress.com/2026/02/06/the-documentation-will-be-easier-to-navigate/
-
The documentation will be easier to navigate
The GitBook documentation for our projects will be easier to navigate than before. We have made earlier statements about how we’ll schedule changes made to the GitBook docs for all our projects, starting from Nitrocid.
We are using different elements to make our documentation easier to navigate, that is, turning walls of text and long doc pages to expandable sections to make key information stand out and to shorten long pages in a way that makes the docs more comprehensive.
As we are reaching the huge milestone day, the docs will become easier to comprehend, as we are working towards the text flow across docs pages to ensure that all related information stays in one place instead of multiple spots in the same page.
Long sections have been broken down to multiple extendable sections, which can be extended by just clicking on the arrow to get more information. Similarly, multiple release notes have been made easier to read by making use of clear dates and changelogs, colored with the following types of change:
- Green: This color indicates an addition of new features (for example, Added DotBlob screensaver)
- Yellow: This color indicates an improvement or a bug fix (for example, Fixed crashes on startup)
- Red: This color indicates a removal of features (for example, Removed native library dependency)
The changelogs will remain populated on GitHub as proper release markers for quick reference, in case documentation is not available.
Also, cards are used to group different features instead of individual page links to make the experience more welcoming, as well as links at the top of each card and the cover picture to give you a quick glimpse of a feature or an item.
This is a final reminder that the new documentation will get rolled out on February 12th!
#docs #documentation #gitbook #news #Tech #Technology #update -
The documentation will be easier to navigate
The GitBook documentation for our projects will be easier to navigate than before. We have made earlier statements about how we’ll schedule changes made to the GitBook docs for all our projects, starting from Nitrocid.
We are using different elements to make our documentation easier to navigate, that is, turning walls of text and long doc pages to expandable sections to make key information stand out and to shorten long pages in a way that makes the docs more comprehensive.
As we are reaching the huge milestone day, the docs will become easier to comprehend, as we are working towards the text flow across docs pages to ensure that all related information stays in one place instead of multiple spots in the same page.
Long sections have been broken down to multiple extendable sections, which can be extended by just clicking on the arrow to get more information. Similarly, multiple release notes have been made easier to read by making use of clear dates and changelogs, colored with the following types of change:
- Green: This color indicates an addition of new features (for example, Added DotBlob screensaver)
- Yellow: This color indicates an improvement or a bug fix (for example, Fixed crashes on startup)
- Red: This color indicates a removal of features (for example, Removed native library dependency)
The changelogs will remain populated on GitHub as proper release markers for quick reference, in case documentation is not available.
Also, cards are used to group different features instead of individual page links to make the experience more welcoming, as well as links at the top of each card and the cover picture to give you a quick glimpse of a feature or an item.
This is a final reminder that the new documentation will get rolled out on February 12th!
#docs #documentation #gitbook #news #Tech #Technology #update -
The rollout schedule for the new Aptivi documentation is up!
#GitBook #Docs #TechNews #TechUpdates #Aptivi #dotnet #csharp #programming
-
The rollout schedule for the new Aptivi documentation is up!
#GitBook #Docs #TechNews #TechUpdates #Aptivi #dotnet #csharp #programming
-
Rollout schedule for the new Aptivi documentation look
As we have stated earlier, we have planned to give our documentation a new look to modernize it and to make it minimal from the start for easier navigation.
The rollout is slated to start on February 15th, with the expected duration of the rollout being three days until the 17th, inclusively. However, there are exceptions applied to some projects.
The following documentation will be updated in this order:
- Projects that will have their documentation updated on February 12th (exception)
- Nitrocid (general rolling docs)
- Terminaux (general rolling docs)
- Projects that will have their documentation updated on February 15th
- BassBoom (general rolling docs)
- SpecProbe
- VisualCard
- Projects that will have their documentation updated on February 16th
- Textify
- Aptivestigate
- Magico
- Colorimetry
- Projects that will have their documentation updated on February 17th
- Nettify
- Metalinker
- ChemiStar
- ResourceLab
- Calendrier
- BskyId
- dotify
- pushrepos
- uprepos
Please note that this is the expected rollout schedule and there may be delays.
Are you excited for the new documentation look?
#Aptivi #documentation #gitbook #news #Tech #Technology #update - Projects that will have their documentation updated on February 12th (exception)
-
Rollout schedule for the new Aptivi documentation look
As we have stated earlier, we have planned to give our documentation a new look to modernize it and to make it minimal from the start for easier navigation.
The rollout is slated to start on February 15th, with the expected duration of the rollout being three days until the 17th, inclusively. However, there are exceptions applied to some projects.
The following documentation will be updated in this order:
- Projects that will have their documentation updated on February 12th (exception)
- Nitrocid (general rolling docs)
- Terminaux (general rolling docs)
- Projects that will have their documentation updated on February 15th
- BassBoom (general rolling docs)
- SpecProbe
- VisualCard
- Projects that will have their documentation updated on February 16th
- Textify
- Aptivestigate
- Magico
- Colorimetry
- Projects that will have their documentation updated on February 17th
- Nettify
- Metalinker
- ChemiStar
- ResourceLab
- Calendrier
- BskyId
- dotify
- pushrepos
- uprepos
Please note that this is the expected rollout schedule and there may be delays.
Are you excited for the new documentation look?
#Aptivi #documentation #gitbook #news #Tech #Technology #update
- Projects that will have their documentation updated on February 12th (exception)
-
You can now see how will our GitBook documentation look like!
#GitBook #Website #TechNews #TechUpdates #Documentation #Docs #Aptivi #Branding #WebDesign
https://officialaptivi.wordpress.com/2026/02/01/heres-your-sneak-peek-of-the-improved-docs-design/
-
You can now see how will our GitBook documentation look like!
#GitBook #Website #TechNews #TechUpdates #Documentation #Docs #Aptivi #Branding #WebDesign
https://officialaptivi.wordpress.com/2026/02/01/heres-your-sneak-peek-of-the-improved-docs-design/
-
Here’s your sneak peek of the improved docs design!
As we’ve stated earlier in one of the last articles about the improved docs design plan, our plan was to make the documentation visually appealing to make the docs more gorgeous and more understandable to a wider audience.
Today, we have finally made the updated, improved documentation design available in the main Aptivi docs page! We have changed the design from simplistic to appealing design, and we’ve made the text less wordy to make the docs more understandable.
This is the current state now, versus the previous design:
We have used cards instead of bullet points with links to give you a comprehensive list of projects and other elements without introducing walls of text. Cover photos are also used to make those cards stand out, ensuring visual appearance. Links will also appear in the titles, if desired, along with a slightly bigger text due to space.
For step-by-step instructions and other listings, we have replaced the traditional bullet points and walls of text with elements like “steppers” and “expandables.” This is to ensure easier comprehension when following the steps while hiding secondary content under expandables. Restructuring the pages is also done to make sure that all key points are in one place instead of different points that point to the same section but scattered to multiple places.
The above image also shows a role of expandables when it comes to addressing different points when sections aren’t enough, such as code of conduct and contribution guidelines.
We are very excited to announce that we’ll start working on evaluating all documentations beginning today to redesign them according to the above principles!
However, all stable and rolling documentations that were branched before February 15th won’t be updated to preserve the history and to show users how we evolved from traditional but wordy docs to minimalistic and modern docs.
The rollout will start gradually on February 15th across projects, starting from the Nitrocid manual, until all documentation has been updated. This ensures that we maintain consistency while being able to update docs for new features and other changes at the same time.
Until then, check out our brand new main docs design!
Take a look! #docs #documentation #gitbook #news #Tech #Technology #update -
Here’s your sneak peek of the improved docs design!
As we’ve stated earlier in one of the last articles about the improved docs design plan, our plan was to make the documentation visually appealing to make the docs more gorgeous and more understandable to a wider audience.
Today, we have finally made the updated, improved documentation design available in the main Aptivi docs page! We have changed the design from simplistic to appealing design, and we’ve made the text less wordy to make the docs more understandable.
This is the current state now, versus the previous design:
We have used cards instead of bullet points with links to give you a comprehensive list of projects and other elements without introducing walls of text. Cover photos are also used to make those cards stand out, ensuring visual appearance. Links will also appear in the titles, if desired, along with a slightly bigger text due to space.
For step-by-step instructions and other listings, we have replaced the traditional bullet points and walls of text with elements like “steppers” and “expandables.” This is to ensure easier comprehension when following the steps while hiding secondary content under expandables. Restructuring the pages is also done to make sure that all key points are in one place instead of different points that point to the same section but scattered to multiple places.
The above image also shows a role of expandables when it comes to addressing different points when sections aren’t enough, such as code of conduct and contribution guidelines.
We are very excited to announce that we’ll start working on evaluating all documentations beginning today to redesign them according to the above principles!
However, all stable and rolling documentations that were branched before February 15th won’t be updated to preserve the history and to show users how we evolved from traditional but wordy docs to minimalistic and modern docs.
The rollout will start gradually on February 15th across projects, starting from the Nitrocid manual, until all documentation has been updated. This ensures that we maintain consistency while being able to update docs for new features and other changes at the same time.
Until then, check out our brand new main docs design!
Take a look!#docs #documentation #gitbook #news #Tech #Technology #update
-
Get ready for the new documentation look preview!
February 1st @ 9:00 PM GMT
-
Get ready for the new documentation look preview!
February 1st @ 9:00 PM GMT
-
Our docs look a bit boring, but we'll work on it to make them more gorgeous!
#GitBook #Docs #csharp #dotnet #programming #TechNews #TechUpdates
https://officialaptivi.wordpress.com/2026/01/29/improvements-planned-for-project-and-other-docs/
-
Our docs look a bit boring, but we'll work on it to make them more gorgeous!
#GitBook #Docs #csharp #dotnet #programming #TechNews #TechUpdates
https://officialaptivi.wordpress.com/2026/01/29/improvements-planned-for-project-and-other-docs/
-
Improvements planned for project and other docs
Documentation is always the most important part of any project and other technology-related topics. This tells users what the project is, how it functions, and how can users use it, and every good project includes documentation.
However, we think that there is room for improvements across the entire Aptivi project documentation workspace, such as Nitrocid, Terminaux, and so on, so we have decided to make a plan for refinements to happen in all project documentations.
Those improvements will make users and developers be able to more comprehensively understand what they’re reading, while providing improved design at the same time. We’ll use more items and elements that are related to layout to make the documentation look much more welcoming.
To save resources, those changes will only land to all rolling manuals. This means that there will be no design updates for both stable and deprecated project docs that were made before March 1st.
The incremental rollout of the new documentation design will start from February 15th. You’ll be able to have a sneak peek of the new design in the main Aptivi GitBook docs page starting February 1st.
#docs #documentation #gitbook #news #Tech #Technology #update -
Improvements planned for project and other docs
Documentation is always the most important part of any project and other technology-related topics. This tells users what the project is, how it functions, and how can users use it, and every good project includes documentation.
However, we think that there is room for improvements across the entire Aptivi project documentation workspace, such as Nitrocid, Terminaux, and so on, so we have decided to make a plan for refinements to happen in all project documentations.
Those improvements will make users and developers be able to more comprehensively understand what they’re reading, while providing improved design at the same time. We’ll use more items and elements that are related to layout to make the documentation look much more welcoming.
To save resources, those changes will only land to all rolling manuals. This means that there will be no design updates for both stable and deprecated project docs that were made before March 1st.
The incremental rollout of the new documentation design will start from February 15th. You’ll be able to have a sneak peek of the new design in the main Aptivi GitBook docs page starting February 1st.
#docs #documentation #gitbook #news #Tech #Technology #update
-
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.gitInstead 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.gitrepository. 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.gitYou can interact with it just like any other Git repository.
#docs #documentation #gitbook #KernelSimulator #KS #NKS #news #nitrocid #NitrocidKS #Tech #Technology #update
-
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.gitInstead 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.gitrepository. 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.gitYou can interact with it just like any other Git repository.
#docs #documentation #gitbook #KernelSimulator #KS #NKS #news #nitrocid #NitrocidKS #Tech #Technology #update
-
Does anyone have experience running #GitBook on-premise?! I’d like to know about your experiences and whether features such as Git Sync, GitBook AI, and SSO are also (well) usable when self hosted?!
-
Does anyone have experience running #GitBook on-premise?! I’d like to know about your experiences and whether features such as Git Sync, GitBook AI, and SSO are also (well) usable when self hosted?!
-
We have finished updating the project documentation for Terminaux and for other libraries! You can now see the updated docs.
https://officialaptivi.wordpress.com/2025/05/14/regarding-the-project-documentation/
#Docs #GitBook #Projects #Terminaux #csharp #programming #TechNews #TechUpdates #dotnet
-
We have finished updating the project documentation for Terminaux and for other libraries! You can now see the updated docs.
https://officialaptivi.wordpress.com/2025/05/14/regarding-the-project-documentation/
#Docs #GitBook #Projects #Terminaux #csharp #programming #TechNews #TechUpdates #dotnet
-
We are working on updating the documentation soon, especially Terminaux 7.0 Beta 1.
#Docs #GitBook #Projects #Terminaux #csharp #programming #TechNews #TechUpdates #dotnet
https://officialaptivi.wordpress.com/2025/05/14/regarding-the-project-documentation/
-
We are working on updating the documentation soon, especially Terminaux 7.0 Beta 1.
#Docs #GitBook #Projects #Terminaux #csharp #programming #TechNews #TechUpdates #dotnet
https://officialaptivi.wordpress.com/2025/05/14/regarding-the-project-documentation/
-
We've rolled out stable manuals for Nitrocid KS service packs. Check them out here!
https://aptivi.gitbook.io/aptivi
#NitrocidKS #KernelSimulator #TechNews #Nitrocid #csharp #programming #gitbook #github
-
We've rolled out stable manuals for Nitrocid KS service packs. Check them out here!
https://aptivi.gitbook.io/aptivi
#NitrocidKS #KernelSimulator #TechNews #Nitrocid #csharp #programming #gitbook #github
-
Nitrocid service packs will get their own stable documentation.
#Nitrocid #NitrocidKS #KernelSimulator #TechNews #csharp #programming #dotnet #docs #gitbook
https://officialaptivi.wordpress.com/2025/02/06/nitrocid-stable-documentation-will-be-split-soon/
-
Nitrocid service packs will get their own stable documentation.
#Nitrocid #NitrocidKS #KernelSimulator #TechNews #csharp #programming #dotnet #docs #gitbook
https://officialaptivi.wordpress.com/2025/02/06/nitrocid-stable-documentation-will-be-split-soon/
-
«Вымрут» ли печатные пользовательские инструкции?
В эпоху цифровизации техническая документация меняет свои формы и функции. Печатные издания, когда-то считавшиеся основным источником информации, постепенно уступают место онлайн-форматам. Однако остаётся вопрос: есть ли будущее у печатных документов, или их неизбежно ждёт забвение? В этой статье мы разберём преимущества и недостатки обоих форматов, а также рассмотрим современные инструменты, которые помогают создавать качественную и удобную документацию.
https://habr.com/ru/companies/documenterra/articles/868362/
#цифровизация #техническая_документация #печатные_тексты #онлайн #интерактивность #инструменты #notion #readthedocs #gitbook #slack
-
Is there a service like #gitbook that is hosted and maintained well with good quality rules and privacy, like mastodon servers, #Codeberg or #liberapay ?
-
Is there a service like #gitbook that is hosted and maintained well with good quality rules and privacy, like mastodon servers, #Codeberg or #liberapay ?
-
GitBook is now sponsoring the Arcticons project by providing their documentation tools for free! 🎉
-
Spent this afternoon by converting the Arcticons wiki to a Gitbook page, and adding more info to it!
I didn't like how GitHub wiki's look so, moved it.