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

[PM-13134] update documentation with wasm bindgen recommendations #455

Merged

Conversation

coroiu
Copy link
Contributor

@coroiu coroiu commented Oct 15, 2024

🎟️ Tracking

📔 Objective

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

github-actions bot commented Oct 15, 2024

Logo
Checkmarx One – Scan Summary & Details8355789f-0735-4244-b41b-55a4ffe16ec7

No New Or Fixed Issues Found

@coroiu coroiu force-pushed the PM-13134-update-documentation-with-wasm-bindgen-recommendations branch from 220369c to ad47295 Compare October 15, 2024 09:00
Copy link

cloudflare-workers-and-pages bot commented Oct 15, 2024

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b7be6c2
Status: ✅  Deploy successful!
Preview URL: https://b71fba2e.contributing-docs.pages.dev
Branch Preview URL: https://pm-13134-update-documentatio.contributing-docs.pages.dev

View logs

@coroiu coroiu force-pushed the PM-13134-update-documentation-with-wasm-bindgen-recommendations branch from ad47295 to 00d8cd3 Compare October 15, 2024 09:06
@coroiu coroiu force-pushed the PM-13134-update-documentation-with-wasm-bindgen-recommendations branch from 88507fc to 66a7918 Compare October 15, 2024 09:10
@coroiu coroiu marked this pull request as ready for review October 16, 2024 14:29
@coroiu coroiu requested a review from a team as a code owner October 16, 2024 14:29
@justindbaur justindbaur self-requested a review October 21, 2024 13:55
Copy link
Member

@justindbaur justindbaur left a comment

Choose a reason for hiding this comment

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

A few minor things, but looking great!

@coroiu coroiu requested a review from justindbaur October 25, 2024 12:17
@coroiu coroiu requested a review from a team as a code owner October 29, 2024 08:11
@coroiu coroiu requested a review from Hinton October 29, 2024 12:52

:::tip

**In short:** Use `tsify` unless the web-side needs to call functions or interact with Rust objects
Copy link
Member

Choose a reason for hiding this comment

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

For the future, you can assign a custom title to admonitions, https://docusaurus.io/docs/markdown-features/admonitions#specifying-title

@coroiu coroiu merged commit fea5921 into main Oct 29, 2024
8 checks passed
@coroiu coroiu deleted the PM-13134-update-documentation-with-wasm-bindgen-recommendations branch October 29, 2024 14:30
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.

3 participants