Document API changes (manual approach) #95
Merged
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.
In this PR I've mainly kept the high-level documentation as it was. Then, I added warning messages about what methods are deprecated and what are the new ones that developers should use instead.
Finally, I decided to include a new section in the docs that will contain the Extensions API Reference. This is generated automatically with TypeDoc and it includes the TypeScript interfaces, their methods, params, return types, and examples that are documented in the source code of pinata.
I believe this is the sweet spot we're looking for: having a high-level documentation (tutorials, concepts, etc) and the API Reference that developers can use.
To learn more about how the API Reference is generated automatically, go to the pinata repo and check out the README of the
extensions-preload
module.@technicallyjosh You can serve the documentation by cloning the repo and running:
Visit http://localhost:8000