Skip to content

Conversation

smutyala1at
Copy link

@smutyala1at smutyala1at commented Jul 8, 2025

Thank you for contributing to Mesh! We appreciate your effort and dedication to improving this project. To ensure that your contribution is in line with the project's guidelines and can be reviewed efficiently, please fill out the template below.

Remember to follow our Contributing Guide before submitting your pull request.

Summary

Integrated markdown documentation generation into the main build pipeline. This automatically produces structured documentation during builds to support Mesh RAG training data generation.

Affect components

Please indicate which part of the Mesh Repo

  • @meshsdk/common
  • @meshsdk/contract
  • @meshsdk/core
  • @meshsdk/core-csl
  • @meshsdk/core-cst
  • @meshsdk/hydra
  • @meshsdk/provider
  • @meshsdk/react
  • @meshsdk/svelte
  • @meshsdk/transaction
  • @meshsdk/wallet
  • Mesh playground (i.e. https://meshjs.dev/)
  • Mesh CLI

Type of Change

Please mark the relevant option(s) for your pull request:

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Bug fix (non-breaking change which fixes an issue)
  • Code refactoring (improving code quality without changing its behavior)
  • Documentation update (adding or updating documentation related to the project)

Related Issues

Please add the related issue here if any

Checklist

Please ensure that your pull request meets the following criteria:

  • My code is appropriately commented and includes relevant documentation, if necessary
  • I have added tests to cover my changes, if necessary
  • I have updated the documentation, if necessary
  • All new and existing tests pass (i.e. npm run test)
  • The build is pass (i.e. npm run build)

Additional Information

If you have any additional information or context to provide, such as screenshots, relevant issues, or other details, please include them here.

Copy link

vercel bot commented Jul 8, 2025

@smutyala1at is attempting to deploy a commit to the MeshJS Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jul 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mesh-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2025 5:55am

@HinsonSIDAN
Copy link
Member

Suggest to move the static docs hosted in a separate repository. This approach is exactly what we did in early days of building https://docs.meshjs.dev/. However, this would add excessive burden to devs for daily maintenance

  • Take extra effort to generate docs
  • Slight change can create huge conflicts in generated docs, and the file is usually too big to make a typical laptop taking minutes to load the conflict resolving view in VSCode -> adding >10mins for each push

Given above early witnesses before, we decided to remove exactly these generated docs from committing to core repo and contain them only in CI.

@HinsonSIDAN
Copy link
Member

@smutyala1at @Technosophorso Additional suggestion -

After understanding this doc gen is for mnemos, would suggest generate a static docs first in separate repo, proving the concept before automating docs gen for that. Think that would make product iteration faster

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.

4 participants