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

[DOC]: Broken link to Codec compatibility Table; Inconsistent Compat-Table MD files. #1126

Open
1 task done
macrogreg opened this issue Nov 16, 2024 · 0 comments
Open
1 task done
Labels

Comments

@macrogreg
Copy link

  • Is the documentation missing for a specific object ?

Yes.

The API docs for startRecorder(..) contain a link to a "Codec compatibility Table".
That link is broken.

Notably, two codec compatibility tables seem to exist in the repo:

Their contents are similar but not identical. Please consider removing the superfluous copy and updating the remaining copy with current data.

Those MD files are hard to find by Googling or searching the repo, unless you already know their contents. Please, consider fixing the link from the API docs. :)
I noticed that the file 'https://flutter-sound.canardoux.xyz/guides_codec.html' actually exists. I.e., only the .html is missing in the existing link. However, the HTML corresponding to the other MD file mentioned above does not appear to exist.

(Notably, I remember browsing the package docs, and I think there were more links to the Codec compatibility Table that were broken. Unfortunately, I did not note down which specific pages were affected, so I could be wrong in this regard.)

Thank you for your work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant