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

Integrate Vocs framework and add documentation setup added required files #42

Closed
wants to merge 1 commit into from
Closed

Integrate Vocs framework and add documentation setup added required files #42

wants to merge 1 commit 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
  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

Copy link
Member

@dmirgaleev dmirgaleev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's clean up a little bit more. I think we don't need the dist folder and lock files. Also, we already have https://github.com/dipdup-io/stone-packaging/blob/master/docs/pages/resourcers.md, you can use it (perhaps you need to rebase for that.

@akintewe
Copy link
Contributor Author

alright noted ill do that now

@akintewe akintewe closed this Sep 30, 2024
@akintewe akintewe deleted the vocs-integration-new branch September 30, 2024 12:31
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
2 participants