Add api-extractor generated docs for di and context export paths #6979
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
5 tasks
eljefe223
approved these changes
Jun 7, 2024
janechu
added a commit
that referenced
this pull request
Jun 13, 2024
# Pull Request ## 📖 Description This change fills out the dependency injection documentation with some examples, for regular JavaScript and dependency injection for web components. ## 👩💻 Reviewer Notes The document does not contain an exhaustive list of all the capabilities of our current dependency injection utilities. We will be adding generated API documentation for this, and all other specific exports for users to refer to. See #6979 ## ✅ Checklist ### General <!--- Review the list and put an x in the boxes that apply. --> - [ ] I have included a change request file using `$ yarn change` - [ ] I have added tests for my changes. - [x] I have tested my changes. - [x] I have updated the project documentation to reflect my changes. - [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project. ## ⏭ Next Steps - Add `api-extractor` generated documentation for all named exports.
janechu
force-pushed
the
users/janechu/add-api-extractor-to-all-exports
branch
from
f76306d to
f4373e5
Compare
radium-v
approved these changes
Jul 31, 2024
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.
Pull Request
📖 Description
This change points the
api-extractorto thediandcontextexport paths and adds this generated documentation to the documentation site.🎫 Issues
Resolves #6090
👩💻 Reviewer Notes
This is was a little fiddly as the
api-extractordoes not export export paths, additionally the way theapi-documentorworks assumes a single entry path. This is why if any additions need to be made to expose more export paths, we will need to edit 3 different files to get the documentation to show up on the documentation website.✅ Checklist
General
$ yarn change