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

Create page for chip support status #377

Open
3 tasks done
f-hollow opened this issue Jan 2, 2025 · 1 comment
Open
3 tasks done

Create page for chip support status #377

f-hollow opened this issue Jan 2, 2025 · 1 comment
Labels
Priority: Medium Issue affecting content rendering, its UX, or readability Status: In Progress Issue is being worked on Type: Feature Request Feature Request for developer-portal

Comments

@f-hollow
Copy link
Collaborator

f-hollow commented Jan 2, 2025

Checklist

  • Checked the issue tracker for similar issues to ensure this is not a duplicate.
  • Described the feature in detail and justified the reason for the request.
  • Provided specific use cases and examples.

Feature description

A separate category of pages is required to indicate the Espressif SoCs' support status in ESP-IDF and other projects.

Use cases

Such pages will be used for each new chip for which the support in other projects is being added.

Alternatives

No response

Additional context

No response

@f-hollow
Copy link
Collaborator Author

Summary of work done

This is to summarize what has been done so far.

#98

This PR added a chip support status page for the ESP32-C61. All content was in markdown committed to the repository.

#186

The analysis of the chip support status page revealed that it consists of the following:

  • Generic intro part
    • (static) Can be considered static as it has more or less stabilized in this comment before the bullet point section
  • Project intro part(s)
    • (semi-static) (For IDF) Needs to be updated only when new IDF versions are expected
    • (more dynamic) (Other projects) Projects need to be added once it is decided to add support for a chip
  • Supported features
    • (dynamic) Dynamic part, partially put together manually
    • Later, its preparation will be automated

This PR adds a shortcode to pull the dynamic parts from a JSON file.

#330 and #331

In these PRs, the pulled content's format is changed from JSON to markdown.

The previously used emoji shortcodes :white_check_mark: were replaced with their unicode symbols ✅. This setup seems to be stable and the page loads much faster compared to the scenario with dynamic rendering of emoji shortcodes in javascript.

#376

It was decided to further split the chip support page contents as follows:

  • (dynamic) Last updated
  • (static) Generic intro part
  • ESP-IDF project intro part
    • (semi-static) (For IDF) Needs to be updated only when new IDF versions are expected
    • (dynamic) Supported features
  • (static) Other projects intro part
    • (dynamic) Supported projects

Now the dynamic parts are stored in JSON and pulled with the chipstatus shortcode wherever they are needed on the page.

Further steps

Deploy chip status JSON files using CI

  • For script repo: Auto-push latest JSON files from script repo to production
  • For this repo: Pull latest JSON files from script repo to previews

@f-hollow f-hollow added Priority: Medium Issue affecting content rendering, its UX, or readability Status: In Progress Issue is being worked on labels Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium Issue affecting content rendering, its UX, or readability Status: In Progress Issue is being worked on Type: Feature Request Feature Request for developer-portal
Projects
None yet
Development

No branches or pull requests

1 participant