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

Documentation fixes #2841

Merged
merged 32 commits into from
Jul 16, 2024
Merged

Documentation fixes #2841

merged 32 commits into from
Jul 16, 2024

Commits on Jul 16, 2024

  1. Add definitions for FLASH_INIT_DATA and FLASH_INIT_DATA_VCC.

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    a0e8259 View commit details
    Browse the repository at this point in the history

  2. Review Host and Rp2040 README

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    9187ca2 View commit details
    Browse the repository at this point in the history

  3. Tidy Host Emulator documentation 

    Put everything into Host/README, arch/host/index is just a landing page.
Clarify availability of ARCH_xx and SOC_xx macros.
    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    1ac0f10 View commit details
    Browse the repository at this point in the history

  4. Update note on clang-tidy

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    0f6ef9e View commit details
    Browse the repository at this point in the history

  5. USE_US_TIMER not applicable to Esp32

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    a4f4231 View commit details
    Browse the repository at this point in the history

  6. I2S driver not implemented yet for Esp32

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    caedcc0 View commit details
    Browse the repository at this point in the history

  7. Update notes on STRICT setting

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    88577ac View commit details
    Browse the repository at this point in the history

  8. Sanitizers moved to main build

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    6d62c75 View commit details
    Browse the repository at this point in the history

  9. Change use of build variables to configuration variables

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    44c7fc4 View commit details
    Browse the repository at this point in the history

  10. Avoid use of typographic quotes

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    2df92fa View commit details
    Browse the repository at this point in the history

  11. Tidy up envvar references

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    04c67f7 View commit details
    Browse the repository at this point in the history

  12. Replace non-breaking space with regular space

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    5ae61e5 View commit details
    Browse the repository at this point in the history

  13. Update notes on esp8266 toolchain

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    9a022fa View commit details
    Browse the repository at this point in the history

  14. Offer some suggestions on random restarts

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    5deea48 View commit details
    Browse the repository at this point in the history

  15. Fix Esp32/Host component titles

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    d3727d3 View commit details
    Browse the repository at this point in the history

  16. Update README/About pages: Focus should be on C++

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    b650186 View commit details
    Browse the repository at this point in the history

  17. Fix spelling errors / UTF-8 encoding issues

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    314d2a0 View commit details
    Browse the repository at this point in the history

  18. Remove deprecated SPIFFS variables from documentation

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    3688b7d View commit details
    Browse the repository at this point in the history

  19. Add note on status of espconn_ functions with updated lwip2 stack

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    4a71d5d View commit details
    Browse the repository at this point in the history

  20. Review debugging notes 

    Remove lots of duplication
Put debugging guides in separate section, page in top menu
Put tools and debugging pages immediately after getting-started
Put eclipse debugging for all architectures on single page
Page in `information` not required
    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    0637484 View commit details
    Browse the repository at this point in the history

  21. Write python script to scan for dodgy characters

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    481824a View commit details
    Browse the repository at this point in the history

  22. Fix dodgy characters 

    Don't touch license files.
    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    319ccc6 View commit details
    Browse the repository at this point in the history

  23. Updates

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    5e58bbf View commit details
    Browse the repository at this point in the history

  24. Fixes

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    e6a04f5 View commit details
    Browse the repository at this point in the history

  25. Move contents of Tools/ci/README into main CI information page

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    b61ca9a View commit details
    Browse the repository at this point in the history

  26. Make information applicable to all architectures.

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    bf4ef8c View commit details
    Browse the repository at this point in the history

  27. Add Delegate class reference 

    Breathe can't handle `Delegate< ReturnType(ParamTypes...) >`
    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    7aab28f View commit details
    Browse the repository at this point in the history

  28. Review Arch README pages

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    092a359 View commit details
    Browse the repository at this point in the history

  29. Revise Windows install intro

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    9128050 View commit details
    Browse the repository at this point in the history

  30. Fix links

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    6d21873 View commit details
    Browse the repository at this point in the history

  31. Typo: rephrase.

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    af84f60 View commit details
    Browse the repository at this point in the history

  32. Quick run through codespell

    @mikee47
    mikee47 committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    264916f View commit details
    Browse the repository at this point in the history