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

Add documentation for working with JSON in Runnables #1

Open
ospencer opened this issue Dec 10, 2021 · 8 comments
Open

Add documentation for working with JSON in Runnables #1

ospencer opened this issue Dec 10, 2021 · 8 comments
Assignees
Labels
docs-needed Updates to docs for new or revised features

Comments

@ospencer
Copy link
Contributor

ospencer commented Dec 10, 2021

This would include language-specific examples.

@LauraLangdon LauraLangdon added the docs-needed Updates to docs for new or revised features label Mar 16, 2022
@LauraLangdon
Copy link
Contributor

Is this the kind of thing you were referring to, @ospencer? We should we also have a code example showing how to interact with that a la PR #81.

@ospencer
Copy link
Contributor Author

Not quite! For this we want some concrete examples of getting some JSON, parsing it, modifying it, etc.

Sort of like an example use case.

@flaki
Copy link
Contributor

flaki commented Mar 18, 2022

Once we have set up our example code workflow, I'd say this one should go into the tier three (tutorial) section, I'd imagine 'working with JSON' would be a tutorial series with various (multi-language) examples on parsing, generating, modifying JSON as Oscar mentions, with all examples available in a folder of the code-snippets/examples repo, and a guide in the docs taking folks through using these code snippets, pulling from this repo.

@LauraLangdon
Copy link
Contributor

Great! Okay, so we'll circle back to this once #81 is finished?

@flaki
Copy link
Contributor

flaki commented Mar 19, 2022

yep, exactly!

@flaki
Copy link
Contributor

flaki commented Mar 22, 2022

@ramonh & @LauraLangdon will start pairing and creating the guide in JavaScript as a start.

@LauraLangdon
Copy link
Contributor

From today's docs meeting notes:

  • Laura: I don’t have the content knowledge to work on this on my own, but I’d happily pair with someone on it
  • Flaki: once we have the code snippets workflow up & running, this could be a new guide with specific code examples around JSON handling in runnables
    We can have a guide/tutorial for creating runnables in multiple languages for manipulating JSON data
  • These Runnables will live in a testing file like https://github.com/suborbital/reactr/tree/main/rwasm/testdata so that they’ll be maintained. They can be used across repos.
  • Idea: Pair on creating a Javy app and create a walkthrough for handling JSON from there

@flaki
Copy link
Contributor

flaki commented May 6, 2022

some of these might be useful for the above, in terms of the useful things to do with JSON beyond the basics.

@LauraLangdon LauraLangdon removed their assignment Sep 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-needed Updates to docs for new or revised features
Projects
None yet
Development

No branches or pull requests

4 participants