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: update docs for @next version of xchainjs #11

Open
mikewyszinski opened this issue Jul 9, 2021 · 0 comments · May be fixed by #12
Open

ADD: update docs for @next version of xchainjs #11

mikewyszinski opened this issue Jul 9, 2021 · 0 comments · May be fixed by #12
Assignees

Comments

@mikewyszinski
Copy link
Collaborator

mikewyszinski commented Jul 9, 2021

Overview

A new version of xchainjs is being undertaken, as part of that effort we should update the docs.

Proposed Changes

  1. ADD a cookbook/recipes section - to help newcomers quickly find snippets of common uses for xchainjs
  2. ADD an API section - a fully cross-linked JSdoc should be generated and embedded or linked to
  3. REMOVE detailed design sections - currently the build step generates documentation based on .md files inside xchainjs , perhaps we should maintain those as documentation for xchainjs maintainers and have this documentation only be for users of the xchainjs lib
  4. ADD a sample applications section - @next version of xchainjs will have 2-3 maintained sample applications , the docs should describe them and link to them
  5. ADD a getting started section - should have bash and code snippets to quickly start using the library
@mikewyszinski mikewyszinski linked a pull request Jul 9, 2021 that will close this issue
@mikewyszinski mikewyszinski self-assigned this Jul 10, 2021
hippocampus-web3 pushed a commit that referenced this issue Sep 30, 2023
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 a pull request may close this issue.

1 participant