Feature Request: Switch from Vitepress to Vuepress for Documentation

Problem Statement

The current documentation system for Hazaar MVC uses Vitepress. However, there is a need to switch to Vuepress to allow documentation to be written directly in markdown within the main library code work folder. This approach will enable the hazaar-docs project to pull these documents and build a static site using Vuepress, streamlining the documentation process and ensuring it is closely aligned with the codebase.

Proposed Solution

Transition from Vitepress to Vuepress for generating the Hazaar MVC documentation. This involves configuring Vuepress to pull markdown files from the main library code work folder and generate a static documentation site.

Implementation Details

1. Setup Vuepress:

   • Install Vuepress and configure it for the hazaar-docs project.
   • Create a config.js configuration file to define the structure and settings for the documentation site.

2. Restructure Documentation Files:

   • Organize the markdown documentation files within the main library code work folder.
   • Ensure that the Vuepress configuration points to the correct directories and files for building the documentation.

3. Integrate Documentation with Codebase:

   • Configure Vuepress to pull the markdown files from the main library code work folder during the build process.
   • Ensure that any changes to the documentation in the code work folder are reflected in the static site generated by Vuepress.

4. Update Documentation Build Pipeline:

   • Modify the build pipeline for the hazaar-docs project to use Vuepress instead of Vitepress.
   • Ensure the build pipeline can generate and deploy the static documentation site using Vuepress.

5. Custom Theme (Optional):

   • Develop a custom theme for Vuepress to match the styling of the main public Hazaar MVC website, ensuring a consistent user experience.

Benefits

• Unified Documentation: Writing documentation directly within the main library code work folder ensures it is kept up-to-date and closely aligned with the codebase.
• Streamlined Workflow: The hazaar-docs project can pull the latest markdown files and build the documentation site, simplifying the update process.
• Flexibility: Vuepress offers extensive customization options and plugins, allowing for a tailored documentation site that meets specific needs.

Acceptance Criteria

• Vuepress is successfully set up and configured for the hazaar-docs project.
• Documentation is organized within the main library code work folder and correctly referenced by Vuepress.
• The build pipeline for hazaar-docs is updated to use Vuepress and generates a static site.
• The static documentation site generated by Vuepress accurately reflects the content of the markdown files in the main library code work folder.

Note

Switching to Vuepress will require initial setup and configuration changes, but it will provide a more integrated and streamlined approach to maintaining and building documentation for Hazaar MVC.