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

docs: espressif: fix formatting of markdown #1790

Merged
merged 1 commit into from
Sep 4, 2023

Conversation

utzig
Copy link
Member

@utzig utzig commented Sep 2, 2023

Fix documentation issues for the rendering of the Espressif README page. No content is changed with this commit, but formatting and line breaks are set to approximately 100 columns.

Fix documentation issues for the rendering of the Espressif README
page. No content is changed with this commit, but formatting and
line breaks are set to approximately 100 columns.

Signed-off-by: Fabio Utzig <[email protected]>
@utzig utzig requested a review from almir-okato September 2, 2023 19:01
@utzig
Copy link
Member Author

utzig commented Sep 2, 2023

Supersedes #1789, tested locally...

Copy link
Collaborator

@almir-okato almir-okato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Thanks @utzig, I tried to test it locally but couldn't build properly using Ruby Gems (tried with and without GitHub Pages Docker image), would be possible to add the instructions somewhere in the project?

@almir-okato almir-okato merged commit b58962f into mcu-tools:main Sep 4, 2023
54 checks passed
@utzig utzig deleted the fix-espressif-doc branch September 4, 2023 21:30
@utzig
Copy link
Member Author

utzig commented Sep 4, 2023

LGTM

Thanks @utzig, I tried to test it locally but couldn't build properly using Ruby Gems (tried with and without GitHub Pages Docker image), would be possible to add the instructions somewhere in the project?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll

^ Is this missing something?

I submitted PR #1798 which adds emoji support, missing here https://docs.mcuboot.com/readme-espressif.html#building-bootloader-with-flash-encryption. Also adds webrick required for ruby > 3.

I tested locally with ruby 3.0.6 (shipped with my distro) and 2.7.4 (used by github pages) which I manage with rbenv. rubygems comes with disto as well; install the required bundler with: gem install bundler -v 1.17.2, and run bundle install. I never use docker for ruby/python stuff...

@almir-okato
Copy link
Collaborator

LGTM
Thanks @utzig, I tried to test it locally but couldn't build properly using Ruby Gems (tried with and without GitHub Pages Docker image), would be possible to add the instructions somewhere in the project?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll

^ Is this missing something?

I submitted PR #1798 which adds emoji support, missing here https://docs.mcuboot.com/readme-espressif.html#building-bootloader-with-flash-encryption. Also adds webrick required for ruby > 3.

I tested locally with ruby 3.0.6 (shipped with my distro) and 2.7.4 (used by github pages) which I manage with rbenv. rubygems comes with disto as well; install the required bundler with: gem install bundler -v 1.17.2, and run bundle install. I never use docker for ruby/python stuff...

Yes I tried to build using those instructions from docs.github.com.
But with the updates from your PR #1798, it worked fine, so I guess the problem was probably related to plugins version from Gemfile.

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

Successfully merging this pull request may close these issues.

2 participants