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

docs(examples): add README for language level #1304

Conversation

vados-cosmonic
Copy link
Contributor

Feature or Problem

While users are perusing examples, it's probably a good idea to add some language-specific information at the root for the given language.

As we current have our example structure set up to be examples/<language>/(actors|...), we have a change to add a README at the examples/<language> level.

This commit adds READMEs for language-level folders under examples.

Related Issues

Release Information

Consumer Impact

Testing

Unit Test(s)

Acceptance or Integration

Manual Verification

@vados-cosmonic vados-cosmonic requested a review from a team as a code owner January 11, 2024 11:52
@vados-cosmonic vados-cosmonic force-pushed the docs/examples/per-language-readme branch 2 times, most recently from 62116b0 to 9892a38 Compare January 11, 2024 12:19
@vados-cosmonic vados-cosmonic force-pushed the docs/examples/per-language-readme branch 2 times, most recently from 31fcc0f to e5801a2 Compare January 12, 2024 08:40
Copy link
Member

@brooksmtownsend brooksmtownsend left a comment

Choose a reason for hiding this comment

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

A couple requests for markdown formatting.

Only other thing I'd love to have in golang / rust is just a snippet that details that those languages are supported out-of-the-box with wash build, and maybe a experimental note for TypeScript since we don't have that yet

examples/golang/README.md Show resolved Hide resolved
examples/golang/README.md Outdated Show resolved Hide resolved
While users are perusing examples, it's probably a good idea to add
some language-specific information at the root for the given
language.

As we current have our example structure set up to be
`examples/<language>/(actors|...)`, we have a change to add a README
at the `examples/<language>` level.

This commit adds READMEs for language-level folders under examples.

Signed-off-by: Victor Adossi <vadossi@cosmonic.com>
@vados-cosmonic vados-cosmonic force-pushed the docs/examples/per-language-readme branch from 864ffe1 to 84bb03e Compare January 12, 2024 15:40
Copy link
Member

@brooksmtownsend brooksmtownsend left a comment

Choose a reason for hiding this comment

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

Love it!

Copy link
Member

@brooksmtownsend brooksmtownsend left a comment

Choose a reason for hiding this comment

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

I SAID: I LOVE IT!

@vados-cosmonic vados-cosmonic merged commit 80ed050 into wasmCloud:main Jan 12, 2024
43 checks passed
@vados-cosmonic vados-cosmonic deleted the docs/examples/per-language-readme branch January 12, 2024 17:23
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

3 participants