Documentation Search That Actually Works

<!-- Add to your documentation layout -->
<input id="docs-search" type="search"
  placeholder="Search documentation..." autocomplete="off">
<ul id="docs-results"></ul>

<script>
  // Use a SEARCH key here, never the private key
  const SEARCH_KEY = 'your_search_key';
  const input = document.getElementById('docs-search');
  const list = document.getElementById('docs-results');
  let timer;

  input.addEventListener('input', () => {
    clearTimeout(timer);
    timer = setTimeout(async () => {
      const q = input.value.trim();
      list.innerHTML = '';
      if (!q) return;
      const res = await fetch(
        'https://app.searchjetengine.com/api/v1/search?limit=8&q=' +
          encodeURIComponent(q),
        { headers: { 'Authorization': 'Bearer ' + SEARCH_KEY } }
      );
      const { results } = await res.json(); // array of hits
      for (const hit of results) {
        const li = document.createElement('li');
        const a = document.createElement('a');
        a.href = hit.url;
        a.textContent = hit.title;
        li.appendChild(a);
        list.appendChild(li);
      }
    }, 200);
  });
</script>

// scripts/index-docs.mjs: run after each docs build (CI/server-side)
const docs = [
  {
    id: 'getting-started',
    title: 'Getting Started',
    content: 'Welcome to our documentation...',
    url: 'https://docs.example.com/getting-started',
    type: 'guide',
    metadata: { locale: 'en' }
  },
  // ... more documents
];

const response = await fetch('https://app.searchjetengine.com/api/v1/index/bulk', {
  method: 'POST',
  headers: {
    // Private key from your CI secrets, never shipped to the browser
    'Authorization': 'Bearer ' + process.env.SEARCHJET_PRIVATE_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ documents: docs })
});
console.log(await response.json()); // includes taskUid

// Spot content gaps from your own search calls
const res = await fetch(
  'https://app.searchjetengine.com/api/v1/search?q=' + encodeURIComponent(query),
  { headers: { 'Authorization': 'Bearer YOUR_SEARCH_KEY' } }
);
const data = await res.json();

if (data.total === 0) {
  // Zero-result query: a missing guide or a missing synonym.
  // Send it to your own logging or analytics tool.
  logZeroResult(query);
}

// Every response also includes:
// - data.results: the matching docs
// - data.total: number of matches
// - data.processing_time_ms: search time on the server