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

link in README is broken #40

Open
yanshay opened this issue Aug 12, 2024 · 5 comments
Open

link in README is broken #40

yanshay opened this issue Aug 12, 2024 · 5 comments

Comments

@yanshay
Copy link
Contributor

yanshay commented Aug 12, 2024

The link to "set a bigger heap size" is broken in the README

@bjoernQ
Copy link
Collaborator

bjoernQ commented Aug 13, 2024

Oh yes - it wasn't changed after moving esp-wifi - new link should be https://github.com/esp-rs/esp-hal/blob/main/esp-wifi/tuning.md

@yanshay
Copy link
Contributor Author

yanshay commented Oct 3, 2024

Oh yes - it wasn't changed after moving esp-wifi - new link should be https://github.com/esp-rs/esp-hal/blob/main/esp-wifi/tuning.md

I wanted to submit a PR to fix this but the new link is no longer valid and I couldn't find a tuning.md in esp-wifi and no reference to such in the esp-wifi Readme.md either. Where is the tuning documented now? I recall there were quite a few parameters described there.

@bjoernQ
Copy link
Collaborator

bjoernQ commented Oct 4, 2024

We don't have a separate document anymore - it's now in the crate's docs

@yanshay
Copy link
Contributor Author

yanshay commented Oct 7, 2024

In the esp-wifi crate docs (at least 0.9.1) the link for tuning (under the tuning section) is there but is broken.
Is it because if you remove it in vnext then it disappears? No link specific for that version?

@bjoernQ
Copy link
Collaborator

bjoernQ commented Oct 7, 2024

For 0.9.1 it wasn't yet in the docs but the document still existed: https://github.com/esp-rs/esp-hal/blob/v0.20.0/esp-wifi/tuning.md

After the next release the information should be in the docs instead

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

No branches or pull requests

2 participants