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.

Sign up for GitHub

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

Jump to bottom

Document usage of the web components #269

Open
hudson-newey opened this issue Jan 16, 2025 · 0 comments
Open

Document usage of the web components #269

hudson-newey opened this issue Jan 16, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@hudson-newey
Copy link
Member

hudson-newey commented Jan 16, 2025 •
edited
Loading

We have had reports of people trying out this project, but failing because they

  1. Tried to use the file:/// protocol
  2. Did not have the required CORP, COEP, and CORS headers

These problems are fully justified because there is little to no documentation on how to use the web components (outside of the original technical specs located under ).

To make these web components more accessible and usable, we should:

  • document how to use these web components on the website (perhaps even open ecoacoustics website).
  • Provide links to the technical spec in the README file
@hudson-newey hudson-newey added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hudson-newey