-
Notifications
You must be signed in to change notification settings - Fork 3.1k
docs(angular): config provider usage and content updates #2614
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not crazy about the formatting for the API reference & Interface, but the content additions look good to me.
Do we have an example of someone who does "API Reference" and type documentation really well that perhaps we could get inspiration from? The formatting for the API reference is from Vue's router docs: https://router.vuejs.org/api/index.html#uselink. I'm open to thoughts here on how to make this easier to reason about. The goal is to inform developers about the available Documenting the config interface types is both for knowing which keys are available and what they do. The downside to the table mark-up, is we cannot just copy/paste our interface when we make changes. We need to vet the table and identify missing/outdated config keys and/or documentation comments. |
Dropping a link to an API reference Ben sent in Slack for future reference: https://mui.com/material-ui/customization/theming/#api |
Co-authored-by: Brandy Carney <[email protected]>
Revamps the documentation surrounding the
Config
provider and usage in Angular. If we agree with the general layout and content adjustments, I can make similar changes to React and Vue.Related issues: #2580
Quick preview: https://ionic-docs-git-docs-angular-config-ionic1.vercel.app/docs/angular/config