component-docs

component-docs copied to clipboard

Add syntax highlighting to WIT documentation

7

WIT code is currently unhighlighted as [highlight.js](https://highlightjs.org/) does not support WIT currently. Using the [`mdbook-treesitter`](https://github.com/Corpauration/mdbook-treesitter) preprocessor is a good avenue to add syntax highlighting for all WIT codeblocks in the...

mkatychev

Consistent rules for executable code fragments

2

After the meeting of SIG Docs today, we landed on what are consistent rules for dealing with syntax highlighting for *commands*. While there has been discussion (and there are always...

vados-cosmonic

Discussion: build-first or component-first?

1

While talking with Danny, the thought of whether users who enter the guide should *first* build a component or *compose* a component with already existing functionality came up. I think...

vados-cosmonic

component-docs might benefit from having releases

1

As I was doing some work, it struck me that it would likely be easier for people to try out and get started with running their component if they *didn't*...

vados-cosmonic

After some discussion at the SIG Docs meeting, I expressed the beginnings of a plan to move to a format for the docs that is WIT-first. The basic format for...

vados-cosmonic

In the Docs SIG today there was a discussion about how to simplify the tutorial to make the sections on composition easier to understand. One point that was brought up...

macovedj

Instead of composing with a command component, the `calculator` world could export `wasi:cli/run` itself: ``` package docs:[email protected]; interface calculate { enum op { add, } eval-expression: func(op: op, x: u32,...

kate-goldenring

Ensuring that the language examples always build in CI for every PR is probably something we can do pretty easily -- it would be a good idea to have the...

vados-cosmonic

> `mdbook-alerts` seems "good enough" for both the web and Github display, but IMO this is worth bringing up so that everyone can discuss _Originally posted by @vados-cosmonic in https://github.com/bytecodealliance/component-docs/pull/218#discussion_r2011271456_...

mkatychev

A great answer popped on up Zulip that might be worth sharing more widely: [#general > Stable crypto library which can be converted to wasm @ 💬](https://bytecodealliance.zulipchat.com/#narrow/channel/206238-general/topic/Stable.20crypto.20library.20which.20can.20be.20converted.20to.20wasm/near/504933984) It would be...

vados-cosmonic