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

Pileks/feat/multidocs #317

Merged
merged 13 commits into from
Oct 11, 2023
Merged

Pileks/feat/multidocs #317

merged 13 commits into from
Oct 11, 2023

Conversation

pileks
Copy link
Contributor

@pileks pileks commented Sep 27, 2023

Includes changes to Quick Start and CLI, adding support for all of our client languages.

Prerequisites:

Remaining tasks:

  • Once prerequisites are merged, we can link to polywrap on docs.rs for the Reference documentation in the "Clients" section

@pileks pileks self-assigned this Oct 6, 2023
@pileks pileks marked this pull request as ready for review October 6, 2023 07:13

#### What's going on here?

Using the Polywrap Client, we are invoking the `sha3_256` method of a Wrap found under the [WRAP URI](/concepts/uris) `wrapscan.io/polywrap/sha3@1.0` called the SHA3 Wrap.
Copy link
Member

Choose a reason for hiding this comment

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

NIT: we can reduce the amount of duplicate text in these docs by using snippets for the contents (and not just the code)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm actually looking into markdown partials for this kind of thing!

No need to use snippets when Docusaurus' MDX capabilities allow for partial views.

@dOrgJelli
Copy link
Member

3 more NITs:

  • Somewhere in the quick start pages, I think we should have a call-out saying something like "typings for wraps can be generated by the CLI so their developer experience is 1:1 with traditional SDKs" and link to the CLI section where we codegen the types.
  • The application typings within the CLI page aren't all up-to-date. If you look at the different languages, they're all ab it different. I think we should unify these examples.
  • I think the CLI page looks great, but it feels weird that it only covers integrating wraps into apps. I think we might want to also cover building wraps as well. Maybe these two use-cases for the CLI should be covered in 2 different pages.

All of this could totally be done in a separate PR. I overall love the look and feel of everything 🔥 let's keep iterating and improving on this! It feels much farther along than before!

@pileks
Copy link
Contributor Author

pileks commented Oct 7, 2023

  • Somewhere in the quick start pages, I think we should have a call-out saying something like "typings for wraps can be generated by the CLI so their developer experience is 1:1 with traditional SDKs" and link to the CLI section where we codegen the types.

Agreed 100%

  • The application typings within the CLI page aren't all up-to-date. If you look at the different languages, they're all ab it different. I think we should unify these examples.

Do you mean the wraps we're importing? It does seem that, from what I've gathered talking to you guys, we should probably actually unify all template apps to import the same wrap/do the same thing (maybe even something as dumb as SHA3 invocation).

I think that some of the app templates currently are a bit "gratuitous" in the sense that they are basically full apps instead of just giving people a good starting point with a simple example. We can even keep the more complex templates, as we do have support for pulling templates from non-default sources.

I believe such a move (unified starter examples) would allow us to unify our documentation more, and what are templates but a live documentation example.
We can also leave all our current, more complex templates, and write in the docs how people can pull those.

Let me know what your thoughts on this are and maybe we can discuss this further with all other core devs on ACDC.

  • I think the CLI page looks great, but it feels weird that it only covers integrating wraps into apps. I think we might want to also cover building wraps as well. Maybe these two use-cases for the CLI should be covered in 2 different pages.

Huh, so actually adding a "more advanced" tutorial here. I'm generally OK with that, at least for a very simple example. The thing is that we'd also have to add the concept of sub-invocation here (which shouldn't be too hard to explain).
See in our Notion: https://www.notion.so/polywrap/Multi-language-Docs-e23e3a223b4c4853806e2c0dd48f1981?pvs=4#0f82054e875648589e1dfee300a29f86
There's the "Wrap language specific pages" which essentially cover building Wraps. We could think about giving users an intro to the create wasm command and linking them to the tutorials, once I manage to write them out.

@pileks pileks merged commit f226002 into main Oct 11, 2023
1 check passed
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