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

improve board page detail and board searchability #755

Open
durapensa opened this issue Sep 10, 2021 · 2 comments
Open

improve board page detail and board searchability #755

durapensa opened this issue Sep 10, 2021 · 2 comments

Comments

@durapensa
Copy link
Contributor

I'd like to help improve the detail available on board pages, as well as board searchability. Nothing as crazy as DigiKey ;-) but I suspect some use of data/variables & includes could help, and I'm looking for guidance (new to Jekyll!).

For search, perhaps by using the same mechanism as "features" in downloads.html/downloads.js by adding a new data field, e.g. data-mcu and/or data-components, and including it in the nice downloads-filter section?

For includes for common components (including MCUs), board.md pages could use include tags directly (problematic for people making these pages?) or be conditionally included by the download layout based on variables (above) in board.md pages' front matter?

Could/should bootloaders.json (currently contains 149/234 boards) be generalized to accomplish any of this, rather than storing variables in board.md pages' front matter?

@tannewt
Copy link
Member

tannewt commented Sep 10, 2021

The js search method is definitely the way to go since the site is statically hosted.

I think you could store the data in either place, front matter or js. The js wouldn't need processing but I bet you could generate it from front matter using jekyll.

In the longer term I'd love to see a separate repo for board info like this similar to what I did with nvm.toml.

@durapensa
Copy link
Contributor Author

First attempt at #756, low-hanging fruit by using the existing MCU family data in bootloaders.json.

nvm.toml is nice!

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