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

Update SUMMARY.md #2

Merged
merged 5 commits into from Jan 13, 2023
Merged

Update SUMMARY.md #2

merged 5 commits into from Jan 13, 2023

Conversation

crusso
Copy link
Contributor

@crusso crusso commented Jan 12, 2023

Moritz asked me to review the content so I took the liberty of opening a PR to suggest additional sections.
These are just suggestions.

I'd also consider moving subtyping and generics much earlier, since they will be needed for using much of the base library.

Bounds on generic type parameters, if mentioned at all, can go in the advanced section.

Having written some doc before, I strongly advise putting as many examples as possible into separate files, included from the main document, so you can check them with a script. Or find some tool that extracts the snippets from the md files. Then you can use a simple script or Makefile to check the examples.

Feel free to copy the docusaurus setup from the motoko repo if that helps. It adds some mdx libs that let you do file inclusion and makes many examples runnable on the page (when run in preview mode) via the Motoko javascript interpreter, moc_js.
@Web3NL

@crusso crusso marked this pull request as draft January 12, 2023 10:14
@Web3NL
Copy link
Owner

Web3NL commented Jan 12, 2023

I'd also consider moving subtyping and generics much earlier, since they will be needed for using much of the base library.

Agree!

Having written some doc before, I strongly advise putting as many examples as possible into separate files, included from the main document, so you can check them with a script. Or find some tool that extracts the snippets from the md files. Then you can use a simple script or Makefile to check the examples.

Feel free to copy the docusaurus setup from the motoko repo if that helps. It adds some mdx libs that let you do file inclusion and makes many examples runnable on the page (when run in preview mode) via the Motoko javascript interpreter, moc_js.

Will look into this

While we're at it:
Should we add ''labeled loops, (null) breaks, do blocks, option blocks"?

@Web3NL Web3NL marked this pull request as ready for review January 12, 2023 15:08
@Web3NL Web3NL marked this pull request as draft January 12, 2023 19:53
@Web3NL Web3NL marked this pull request as ready for review January 13, 2023 15:50
@Web3NL Web3NL merged commit 2f349ea into Web3NL:main Jan 13, 2023
@Web3NL Web3NL mentioned this pull request Jan 14, 2023
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.

None yet

2 participants