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 all ways / places where an extension can extend Platform #1349

Open
Sebastian-ubs opened this issue Nov 26, 2024 · 1 comment
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux UX design needed

Comments

@Sebastian-ubs
Copy link
Contributor

Sebastian-ubs commented Nov 26, 2024

User Story
As a extension developer, I want to know which parts of Platform I can extend so that I can understand the possibilities and work with them or request other extension points.

Description
Questions like "can an extension add a component to the main toolbar" or "can an extension replace an existing extension" lead to a need for documentation. Add a place where all possibilities are listed how to extend Platform - together with links and/or examples.
Incomplete list of examples

  • main menu
  • tab menu
  • context menu
  • main toolbar?
  • tab toolbar
  • settings
  • services? data model? ...
  • project types?
  • ...
  • additional projects / resources (e.g. online)
  • another way to open a project / resource (editor / viewer), e.g.
    • dictionary
  • another way to edit data (not the text) of a project / resource, e.g.
    • different biblical terms tool
    • different notes viewer
    • different spell checker

Implementation idea
Add a wiki page to the extensions wiki

Testing ideas

@Sebastian-ubs Sebastian-ubs added documentation Improvements or additions to documentation enhancement New feature or request ux UX design needed labels Nov 26, 2024
@Sebastian-ubs Sebastian-ubs moved this to 📥 For Consideration in Paranext Nov 26, 2024
@Sebastian-ubs
Copy link
Contributor Author

Sebastian-ubs commented Nov 29, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request ux UX design needed
Projects
Status: 📥 For Consideration
Development

No branches or pull requests

1 participant