[SDK-3858] Add documentation for modular variant of library #1502
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
temporarily deployed
to
staging/pull/1502/features
github-actions
bot
temporarily deployed
to
staging/pull/1502/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1502/typedoc
lawrence-forooghian
force-pushed
the
1442-add-typings-for-tree-shakable-version
branch
from
869be09
to
b839715
Compare
lawrence-forooghian
force-pushed
the
1443-add-documentation-for-tree-shakable-version
branch
from
98782c4
to
3d152b9
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1502/features
github-actions
bot
temporarily deployed
to
staging/pull/1502/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1502/typedoc
lawrence-forooghian
changed the title
lawrence-forooghian
force-pushed
the
1443-add-documentation-for-tree-shakable-version
branch
from
3d152b9
to
c9d881f
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1502/features
github-actions
bot
temporarily deployed
to
staging/pull/1502/typedoc
github-actions
bot
temporarily deployed
to
staging/pull/1502/bundle-report
Base automatically changed from
1442-add-typings-for-tree-shakable-version
to
integration/v2
November 21, 2023 00:18
owenpearson
requested changes
Nov 22, 2023
lawrence-forooghian
force-pushed
the
1443-add-documentation-for-tree-shakable-version
branch
from
c9d881f
to
72ba373
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1502/features
lawrence-forooghian
force-pushed
the
1443-add-documentation-for-tree-shakable-version
branch
from
72ba373
to
d750acd
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1502/features
github-actions
bot
temporarily deployed
to
staging/pull/1502/typedoc
github-actions
bot
temporarily deployed
to
staging/pull/1502/bundle-report
owenpearson
approved these changes
Nov 23, 2023
I think the docs/ directory is something that’s meant to contain documentation for direct consumption by users or developers, and not fragments that need to be glued together with something else to be useful.
I imagine there’s plenty of room for improvement here, but it’s a start. Hopefully a tech writer will be able to have a look at it before we release, too. For handling TypeDoc documentation for the two different variants of the library, I’ve resurrected the approach that we used when we had callback-based and Promise-based variants of the library (removed in 2a2ed49). Resolves #1443.
lawrence-forooghian
force-pushed
the
1443-add-documentation-for-tree-shakable-version
branch
from
d750acd
to
48ede7f
Compare
lawrence-forooghian
deleted the
1443-add-documentation-for-tree-shakable-version
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation (TypeDoc and in
README) for the modular variant of the library. See commit messages for more details.Resolves #1443.