Skip to content

Comments and suggestions on JS SDK "Getting started" #19

Closed

Description

@crandmck

Re https://opensource.contentauthenticity.org/docs/js-sdk/getting-started/overview

  • DONE State up front "What you should already know" – i.e. what background we assume the reader has: TypeScript, Web Components, modern JS/ES, and one or more of the libs, React, Vue, Angular, etc. What else? We're making a lot of assumptions about what the reader knows but not stating them.
  • Says "The processing code of this library uses a high-performance WebAssembly binary." Where is this binary? How is it invoked? Could use some more explanation. Is the Wasm code open source?

Quickstart

  • Quickstart shows how to"bring in the library" but then leaves you hanging. Should at least have "Next steps" but better a short tutorial on the top 3 things we expect ppl to do, even if just links to "Guides".
  • Need to give a very brief intro to code sandboxes, e.g. link to https://codesandbox.io/ in case the reader is not familiar
  • Code sandbox just says "Please view the console". Is that the intended result or an error?

Code sandboxes are no longer shown by default, so the last two items have been OBE.

Activity

  1. changed the title [-]Comments and suggestions on docs "Getting started"[/-] [+]Comments and suggestions on JS SDK "Getting started"[/+] on Nov 21, 2022
  2. crandmck commented on Jan 13, 2023

    @crandmck
    CollaboratorAuthor

    @adobe export issue to Jira project CAI

  3. github-jira-sync-bot commented on Jan 13, 2023

    @github-jira-sync-bot

    ✅ Jira issue https://jira.corp.adobe.com/browse/CAI-3282 is successfully created for this GitHub issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions