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

Document API changes (manual approach) #95

Merged
merged 10 commits into from
Feb 24, 2022
Merged

Conversation

felipecruz91
Copy link
Contributor

@felipecruz91 felipecruz91 commented Feb 18, 2022

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:

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Visit http://localhost:8000

@felipecruz91 felipecruz91 requested a review from gtardif February 18, 2022 17:06
@felipecruz91 felipecruz91 merged commit 7b64428 into main Feb 24, 2022
@felipecruz91 felipecruz91 deleted the ext-api-changes-2 branch February 24, 2022 19:45
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 this pull request may close these issues.

2 participants