Skip to content

docs: address feedback to the preview documentation #220

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 1 commit into from
Mar 24, 2022

Conversation

radu-matei
Copy link
Member

@radu-matei radu-matei commented Mar 23, 2022

ref #219

Signed-off-by: Radu Matei [email protected]

@radu-matei radu-matei changed the title docs: address first round of feedback docs: address feedback to the preview documentation Mar 23, 2022
@radu-matei radu-matei force-pushed the docs-feedback branch 3 times, most recently from 898ccfe to 58c40c0 Compare March 24, 2022 03:35
Copy link
Collaborator

@itowlson itowlson left a comment

Choose a reason for hiding this comment

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

I haven't read this fully but it looks pretty good from a skim - no concerns if you want to merge ready for the bug bash. Two comments, one a behind-the-scenes typo that is not visible to readers, one probably a typo but worth checking.

defined using
[WebAssembly Interface (WIT)]((https://github.com/bytecodealliance/wit-bindgen/blob/main/WIT.md)):

```fsharp
// The entrypoint for an HTTP handler.
// The entry point for an HTTP handler.
Copy link
Collaborator

Choose a reason for hiding this comment

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

fsharp?!

Copy link
Member Author

@radu-matei radu-matei Mar 24, 2022

Choose a reason for hiding this comment

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

It's the closest in syntax (for defining functions, which is almost exclusively how we show WIT) so the syntax highlighter we are using actually highlights some useful keywords.

@radu-matei radu-matei merged commit 3ef5ba4 into spinframework:main Mar 24, 2022
@radu-matei radu-matei deleted the docs-feedback branch March 24, 2022 04:14
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