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

Feat/replace md from static to fetched dynamically #331

Conversation

f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Nov 15, 2024

Description

This PR builds up on the previously merged test PRs and adds the chipstatus shortcode that fetches markdown content dynamically for chip support status pages.

The files are fetched from respective links in the shortcodes. For more information on how to upload, edit, or remove these files, see this repo's GitLab mirror > Wiki > Upload files bypassing git.

This PR also replaces the static content on the ESP32-C61 chip status page with the chipstatus shortcode.

Emoji shortcodes

Prior to adding the chip support markdown content statically to this repo, the checkmark ✅ and hourglass ⏳ emojis were replaced with their respective shortcodes :white_check_mark: and :hourglass_flowing_sand:. These shortcodes are text-based hence they are safer then emoji icons directly added to markdown.

Since the chip support markdown content is going to be stored outside of git, the emoji shortcodes were replaced back with their icons. This helps render the fetched markdown content considerably faster on a page. In case these icons cause any issues, we can still use the emoji shortcodes if we revert the commit feat(chip-status): remove emoji shortcode rendering for simplification added in this PR.

Related

Testing

  • Extensive testing has been done in related PRs and locally.

Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow
Copy link
Collaborator Author

@ginkgm PTAL

@f-hollow
Copy link
Collaborator Author

@horw PTAL

@ginkgm
Copy link
Contributor

ginkgm commented Nov 15, 2024

I don't see the preview, but code LGTM!

@pedrominatel pedrominatel merged commit d222177 into espressif:main Nov 15, 2024
3 checks passed
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.

3 participants