search

openfpga-cores-inventory / analogue-pocket

https://openfpga-cores-inventory.github.io/analogue-pocket/
MIT License
71 stars 12 forks source link

[Feature Request] Optional Wikipedia links #472

Open neil-morrison44 opened 10 months ago

neil-morrison44 commented 10 months ago

Hey,

For a while now Pocket Sync's tried to put in a Wikipedia link using the core's name (to varying degrees of success) - realised recently that the inventory could have it as an optional thing defined alongside the display name in the YML & fed out through the API & the website.

Clients (and the website) could show the link for each core that has one & maybe even show the first section as a preview blurb (no idea what Wikipedia's API is like but it seems like something that'd be possible).

Think it could end up really nice & help folks understand what each core actually is, especially now they're getting more niche.

joshcampbell191 commented 10 months ago

This feels out of scope for the project since the current data exposed by the API is entirely based on the contents of the core definition files.

neil-morrison44 commented 10 months ago

I was figuring it'd work similarly to the display_name. In that it's, optionally, populated in repositories.yml rather than any other source - like:

    - display_name: CPS1
      wiki: en.wikipedia.org/wiki/CP_System
      repository: jtbin
      path: pocket/zips/jotego.jtcps1.zip

If added we'd need to do a pass over the repositories.yml adding the links where they exist then modify the template for PRs to mention it for new cores.

joshcampbell191 commented 10 months ago

Wouldn't it make more sense to have "home" pages for each core / platform instead?

neil-morrison44 commented 10 months ago

Theres already a url property in the core definition file for that - but that’s about the core not the thing the core is replicating.

Also it’s rarely populated with anything useful, and some core developers will want to avoid it completely - a Wikipedia link (or Wikipedia content pulled in programmatically using the link) gives a much better idea of what a core is for. Especially now there’s so many of them.