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

Delete rust folder #284

Merged
merged 5 commits into from
Dec 15, 2023
Merged

Delete rust folder #284

merged 5 commits into from
Dec 15, 2023

Conversation

SebastienGllmt
Copy link
Contributor

This PR does a few things:

  • It deletes the old rust folder that only contained deprecated code
  • It fixed the CML docs setup and published them here
  • It updates all the package.json commands to build the new crates instead of the old rust folder crates


# Crate Architecture

For current users, the `rust/ `crate is the main version of CML and is the only one that should be used. There is a workspace in the root directory with crates like `core`, `wasm` etc, which are a part of a big refactor and will eventually replace the rust crate at some point in the future, but are still quite WIP for now. The rust crate when used for WASM builds via the npm scripts in the root repo dir will utilize the `rust/json-gen` crate here in the build scripts to generate typescript definitions for the JSON conversion. The `json-gen-split` crate is the equivalent for the new `core`/`wasm` crates and is not called anywhere from the build scripts, but will someday replace the `rust/json-gen` crate once the refactoring is completed.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure what this was supposed to be referring to since json-gen-split doesn't seem to exist

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this was just out of date and referred to what is in chain/wasm/jso-gen

Copy link
Contributor

@rooooooooob rooooooooob left a comment

Choose a reason for hiding this comment

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

LGTM

@SebastienGllmt SebastienGllmt merged commit bf1e891 into develop Dec 15, 2023
1 check passed
@SebastienGllmt SebastienGllmt deleted the delete-rust branch December 15, 2023 23:47
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.

2 participants