Add docsify docs with quickstart #16
Open
Conversation
This file contains hidden or 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
Added a make command to run docsify.
I want to be able to run the example from the docs and had some issues with port mappings in the dev container.
For now we only support a single item return in dynamo. It was possible to return a slice of data which was not correctly converted to a term. Tests were passing because we only had negative tests and the input for the test was not correctly serialized to JSON. I found this issue while trying to write getting started documentation and writing out a use case.
I needed that in order to debug some data during the integration tests.
Now that the tests are actually correct I need to set fake keys and region for dynamodb local
This was referenced Jan 17, 2021
Closed
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.
Closes #4 . I still need to write up more documentation but this sets up the structure and shows some usage.