Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vocs integration cleanup #43

Closed
wants to merge 2 commits into from
Closed

Vocs integration cleanup #43

wants to merge 2 commits into from

Conversation

akintewe
Copy link
Contributor

This PR addresses issue #21 by integrating the Vocs framework to generate a static site from our markdown documentation files.

Changes made:

  1. Installed and configured Vocs for the project
  2. Organized existing markdown files in the docs/pages directory and pushed required files
  3. Created a vocs.config.ts file to configure the documentation site
  4. Updated the README.md with detailed instructions on:
    • Prerequisites for running the documentation site
    • Installation steps
    • How to run the development server
    • How to build the static site
    • Project structure overview
    • Process for adding new pages to the documentation

To test these changes:

  1. Clone the repository
  2. Follow the installation instructions in the README
  3. Run the development server and verify that the documentation site loads correctly
  4. Build the static site and check that it generates without errors

Closes #21

@akintewe
Copy link
Contributor Author

please check this PR only the necessary files were added, the resources file that was added has been removed and only the existing one remains. Lock files have been removed also. If you have any issues please let me know

@akintewe akintewe closed this Sep 30, 2024
@akintewe akintewe deleted the vocs-integration-cleanup branch September 30, 2024 13:56
@akintewe akintewe restored the vocs-integration-cleanup branch September 30, 2024 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Book] Integrate Vocs framework
1 participant