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

[Docs] Add developer documentation for using/modifying the chrome service #1857

Closed
joshuarrrr opened this issue Jul 7, 2022 · 0 comments · Fixed by #1875
Closed

[Docs] Add developer documentation for using/modifying the chrome service #1857

joshuarrrr opened this issue Jul 7, 2022 · 0 comments · Fixed by #1875
Assignees
Labels
docs Improvements or additions to documentation

Comments

@joshuarrrr
Copy link
Member

As a plugin or core dashboards developer, I'd like to have a README for the chrome service to be able to quickly and consistently integrate plugins with the global application chrome.

Possible questions to answer:

  1. What is the chrome service responsible for?
  2. What are the common integration points plugin authors should be aware of (commonly used getters/setters)?
  3. Are there any key limitations, guardrails, or bounds to be aware of (min/max nav links, breadcrumb depth, etc.)

While a README is probably the quickest and easiest place to start, we could also add a new example that demonstrates usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
2 participants