New Contributions for New Terms: Please read before creating a PR

[Buzzpy]

All the new PRs for adding terms should be committed to the branch develop, as a JSON File in the directory src/content/terms. Following is the sample structure of the JSON file you can add:

File name: api.json

{
  "title": "APIs",
  "subtext": "Application Programming Interfaces",
  "categories": ["all"],
  "author": "Buzzpy",
  "description": {
    "title": "APIs",
    "texts": [
      "An API (Application Programming Interface) is a set of rules that allows different software programs to communicate with each other. It defines how requests and responses should be formatted so that different systems can interact seamlessly.",
      "APIs are used to integrate different services, enabling developers to build applications that interact with other software or services."
    ],
    "image": "https://www.openlegacy.com/hs-fs/hubfs/Picture1-2.webp?width=969&height=509&name=Picture1-2.webp",
    "references": [
      "https://www.postman.com/what-is-an-api/"
    ]
  }
}

Note: if you aren't sure about the category, please look at the other terms on the website to get a basic idea. Or, you can keep it as "all", we'll review it and add the category.

Can't wait to see your contributions!

[RayMathew]

What is "category" for? I also see "keywords" in another commit. How are they different? Please give examples too.

[RayMathew]

Also, there is a label called "references", but CardList.astro seems to be taking only the first element of the array.
https://github.com/Buzzpy/Dev-Encyclopedia/blob/astro-integration/src/components/CardList.astro#L22

Is there a plan to show multiple references in the future?

[RayMathew]

Are images mandatory for all terms? Because otherwise the card shows a missing image icon.

[Buzzpy]

Hello @RayMathew !
Categories were expected to serve as tags (for filtering) and I tested using keywords to improve search (I added keywords to one file only). But we can use one identifier (either keywords or category) for both of those functions, right?

Also, no, images are not mandatory and we have to fix the issue of broken images. I was saving that for today, haha 😄

And about the reference, yes, I think it would be good to have multiple references in the future but this feature can wait until we deploy the Astro-integrated website.

[bellodamilola]

Hello @Buzzpy,

Since categories are expected to serve as tags, shouldn't it be like an array of strings? This way, a term can have multiple tags and this will improve the filtering.

[Buzzpy]

You're right, @bellodamilola. I'll look into that.

[RayMathew]

NOTE! I'm updating all cards to say 'categories' and making them an array of strings. Please continue this format for any new cards you create!