Everything-Explained / evex-client

The SPA that is served by the web server for Everything Explained.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Add Knowledgebase #46

Open Jaeiya opened 3 years ago

Jaeiya commented 3 years ago

Specifically with topics surrounding the RED33M teachings, there exists no way to quickly understand what's being said without having prior knowledge of the topic being spoken about. It would be nice to have an existing knowledgebase, which defines all of the unique terms and concepts that have been created for the purposes of describing the "beyond".

You can think of it as a repository of building blocks which can be referenced and which can also reference other blocks: a block within a block within a block, since this information is very....hierarchal. Each piece of information really does build on the next.

Design

  1. We can use the existing framework and build a static JSON document of knowledge blocks, which can be retrieved when the page loads.
  2. We do want the terms to be discoverable outside of having to search for them, so making sure they are visible when the page loads is paramount.
  3. A filter bar at the top of the page or embedded somewhere near the terms will be mandatory; it's not much of a knowledgebase if you can't search.
  4. Because the data will be loaded all at once, we could enable searching the terms data page, which would likely yield better results, however the performance impact of this would be exponential as the amount of terms grows. We'll just have to see how necessary that would be and also explore database solutions later down the road.
  5. We will need to divvy up the knowledgebase for RED33M and normal teachings; we can't mix the two. We can do this at the CMS layer with a flag for RED33M which also means filtering on the client-side based on that flag. We'll have to weigh the benefits of multiple solutions for that.
  6. We can use the Static Pager to display the term data, but unfortunately we won't be able to use the literature component, as it's use-case falls a bit short of this kind of content.
Jaeiya commented 3 years ago

Knowledge Base

Jaeiya commented 3 years ago

Knowledge Base