Skip to content

Add documentation and stories; update React API #1

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 21 commits into from
Feb 3, 2025
Merged

Add documentation and stories; update React API #1

merged 21 commits into from
Feb 3, 2025

Conversation

@microbit-grace
Copy link
Contributor

@microbit-grace microbit-grace commented Feb 3, 2025 •
edited by microbit-matt-hillsdon
Loading

  • Add Typedoc for React and Vanilla JS (also exported/inlined referenced types so that there is less TypeDoc warnings)
  • Added GH workflow for building and deploying docs using GH pages
  • Removed GH workflow for deploying stories using GH pages (we use CloudFlare instead now)
  • Exported createMakeCodeRenderBlocks for vanilla JS
  • Add usage docs for React and Vanilla JS
  • Flatten options into props for the blocks rendering

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 3, 2025 •
edited
Loading

Deploying makecode-embed with  Cloudflare Pages  Cloudflare Pages

Latest commit: 009a675
Status: ✅  Deploy successful!
Preview URL: https://e18ae0a1.makecode-embed.pages.dev
Branch Preview URL: https://docs.makecode-embed.pages.dev

View logs

microbit-matt-hillsdon
microbit-matt-hillsdon reviewed Feb 3, 2025
View reviewed changes
@microbit-grace microbit-grace changed the title [WIP - DO NOT MERGE] Add API documentation and stories for vanilla Add API documentation and stories for vanilla Feb 3, 2025
@microbit-grace microbit-grace marked this pull request as ready for review February 3, 2025 11:52
@microbit-matt-hillsdon microbit-matt-hillsdon changed the title Add API documentation and stories for vanilla Add documentation and stories; update React API Feb 3, 2025
@microbit-matt-hillsdon microbit-matt-hillsdon merged commit 666bf1f into main Feb 3, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@microbit-matt-hillsdon microbit-matt-hillsdon microbit-matt-hillsdon approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@microbit-grace @microbit-matt-hillsdon