docs: add URL parameters documentation & remove core view gen (#29)

Author: toddeTV

app/pages/results.vue

@@ -12,12 +12,6 @@ const { results } = useQuizSocket('results')
 const route = useRoute()
 const isCoreView = computed(() => route.query.core !== undefined)
 
-// State for core view parameters
-const padding = ref(route.query.padding ? Number(route.query.padding) : 0)
-const scale = ref(route.query.scale ? Number(route.query.scale) : 1)
-const hideResults = ref(route.query.hideResults !== undefined)
-
-// Add body class for core view
 
 // Dynamic styles for core view
 const coreViewStyles = computed(() => {
@@ -30,17 +24,6 @@ const coreViewStyles = computed(() => {
   }
 })
 
-// Function to navigate to core view with parameters
-async function goToCoreView() {
-  const query = {
-    core: '',
-    padding: padding.value,
-    scale: scale.value,
-    hideResults: hideResults.value ? '' : undefined
-  }
-  await navigateTo({ path: '/results', query })
-}
-
 // Fetch initial results
 const { data: fetchedResults, refresh: refreshResults } = await useFetch<Results>('/api/results/current')
 
@@ -175,33 +158,6 @@ async function pickRandomUser(option: string) {
       </UiSection>
     </div>
 
-    <!-- Navigation -->
-    <div v-if="!isCoreView" class="flex flex-col items-center gap-5 mt-8">
-      <div class="flex justify-center gap-5">
-      </div>
-
-      <!-- Core View Controls -->
-      <div class="p-4 w-full max-w-md flex flex-col items-center gap-4">
-        <h3 class="text-lg font-bold">Core View Generator</h3>
-        <div class="grid grid-cols-2 gap-4 w-full">
-          <div class="flex flex-col gap-1">
-            <label for="padding" class="text-sm font-bold">Padding (px)</label>
-            <UiInput id="padding" v-model="padding" type="number" placeholder="e.g., 20" />
-          </div>
-          <div class="flex flex-col gap-1">
-            <label for="scale" class="text-sm font-bold">Scale</label>
-            <UiInput id="scale" v-model="scale" type="number" step="0.1" placeholder="e.g., 1.0" />
-          </div>
-        </div>
-        <div class="flex items-center gap-2">
-          <input id="hideResults" v-model="hideResults" type="checkbox" class="w-4 h-4">
-          <label for="hideResults" class="text-sm font-bold">Hide Results</label>
-        </div>
-        <UiButton @click="goToCoreView">
-          Generate Core View
-        </UiButton>
-      </div>
-    </div>
   </div>
 </template>
 

docs/url-parameters.md

@@ -0,0 +1,78 @@
+# URL Parameters for Frontend pages
+
+This document describes the GET parameters available for customizing page views.
+
+## `/results` Page
+
+### `core`
+
+- **Type**: Flag (presence check)
+- **Default**: Not set
+- **Effect**: Enables core view mode, which removes page padding, removes the page title, and applies bare section styling for embedded display.
+
+### `padding`
+
+- **Type**: Number (pixels)
+- **Default**: `0`
+- **Effect**: Applies padding around the content when in core view mode. Only active when `core` parameter is present.
+
+### `scale`
+
+- **Type**: Number (decimal)
+- **Default**: `1`
+- **Effect**: Applies CSS transform scale to the content. Only active when `core` parameter is present.
+
+### `hideResults`
+
+- **Type**: Flag (presence check)
+- **Default**: Not set
+- **Effect**: Hides vote counts, percentages, and question notes. Displays question marks instead of results. Useful for presentations where results should be revealed later.
+
+### Examples
+
+```text
+/results
+Standard results view with full UI.
+
+/results?core
+Core view with minimal UI, no padding, normal scale.
+
+/results?core&padding=20&scale=0.9
+Core view with 20px padding and 90% scale.
+
+/results?core&hideResults
+Core view with results hidden (shows "?" instead of numbers).
+
+/results?core&padding=30&scale=1.2&hideResults
+Core view with 30px padding, 120% scale, and hidden results.
+```
+
+## `/emojis` Page
+
+### `scale`
+
+- **Type**: Number (decimal)
+- **Default**: `1`
+- **Effect**: Scales emoji size and adjusts spawn padding to prevent emojis from appearing outside viewport.
+
+### `transparency`
+
+- **Type**: Number (decimal, clamped to max 1)
+- **Default**: `1`
+- **Effect**: Sets emoji opacity. Values are clamped to maximum 1.0 (fully opaque).
+
+### Examples
+
+```text
+/emojis
+Standard emoji display with normal size and full opacity.
+
+/emojis?scale=2
+Emojis rendered at double size.
+
+/emojis?transparency=0.5
+Emojis rendered at 50% opacity.
+
+/emojis?scale=1.5&transparency=0.7
+Emojis at 150% size with 70% opacity.
+```