Skip to content

refactor(docs): unify WASM and Javascript Cedarling docs #11941

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

Merged
merged 4 commits into from
Aug 11, 2025

Conversation

ossdhaval
Copy link
Contributor

@ossdhaval ossdhaval commented Aug 8, 2025

Prepare


Description

This PR merges the WASM document into JS document under the tutorial section.

Target issue

closes #issue-number-here

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

Closes #11942,

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval self-assigned this Aug 8, 2025
@mo-auto
Copy link
Member

mo-auto commented Aug 8, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

@mo-auto
Copy link
Member

mo-auto commented Aug 8, 2025

Error: Hi @ossdhaval, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-enhancement Issue or PR is an enhancement to an existing functionality labels Aug 8, 2025
Copy link
Contributor

@SafinWasi SafinWasi left a comment

Choose a reason for hiding this comment

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

Looks good to me.
I was able to generate static HTML files for documentation of the WASM interface. When opened with a browser they look like this:
image

Can we somehow add this to the documentation instead of the Defined API section?

@ossdhaval
Copy link
Contributor Author

Looks good to me. I was able to generate static HTML files for documentation of the WASM interface. When opened with a browser they look like this: image

Can we somehow add this to the documentation instead of the Defined API section?

Great 👏 .

If you list out the steps for creating the static HTML, then we can see if they can be run as part of CI build. That way, a latest copy will be always available for reference. Plus, we are doing something similar for our docs site and Java docs too. So I think this should be achievable. Let me create a new issue targeting this task. And let this current PR merge.

@ossdhaval
Copy link
Contributor Author

Looks good to me. I was able to generate static HTML files for documentation of the WASM interface. When opened with a browser they look like this: image
Can we somehow add this to the documentation instead of the Defined API section?

Great 👏 .

If you list out the steps for creating the static HTML, then we can see if they can be run as part of CI build. That way, a latest copy will be always available for reference. Plus, we are doing something similar for our docs site and Java docs too. So I think this should be achievable. Let me create a new issue targeting this task. And let this current PR merge.

Here is the issue to track this.

@ossdhaval ossdhaval enabled auto-merge (squash) August 11, 2025 07:51
@ossdhaval ossdhaval merged commit 644b80e into main Aug 11, 2025
2 checks passed
@ossdhaval ossdhaval deleted the docs-merge-wasm-into-javascript branch August 11, 2025 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-enhancement Issue or PR is an enhancement to an existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: refactor(docs): unify WASM and Javascript Cedarling docs -autocreated
4 participants