sourcey / sourcey/sourcey

Interaction does not work in preview

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.4k
Forks
335
Avg merge
2m
Merged PRs (30d)
1

Description

Reproduction steps:

  • Install project
  • Run sourcey dev

Expected behavior:

Preview/dev server to display the documentation exactly how it is going to be presented after being built

Actual behavior:

No interaction works on the website. Scrollspy, search, drop-downs, etc.

Relevant logs

There are no errors in the console, no logs, no failed network requests. Only these warnings in the console:

Failed to resolve dependency: preact, present in client 'optimizeDeps.include'
Failed to resolve dependency: preact/jsx-runtime, present in client 'optimizeDeps.include'
Failed to resolve dependency: preact/jsx-dev-runtime, present in client 'optimizeDeps.include'
Failed to resolve dependency: preact/debug, present in client 'optimizeDeps.include'
Failed to resolve dependency: preact/devtools, present in client 'optimizeDeps.include'

Configurations

package.json:

{
  "name": "api-docs",
  "private": true,
  "type": "module",
  "version": "1.0",
  "packageManager": "pnpm@12.3.4",
  "engines": {
    "node": ">=24"
  },
  "scripts": {
    "preview": "sourcey dev",
    "build": "sourcey build"
  },
  "devDependencies": {
    "sourcey": "^3.6.5"
  }
}

sourcey.config.ts:

import { defineConfig, markdown, openapi } from "sourcey";

export default defineConfig({
  name: "API",
  theme: {
    preset: "default",
  },
  navigation: {
    tabs: [
      {
        tab: "Documentation",
        slug: "",
        source: markdown({
          groups: [
            {
              group: "Getting started",
              pages: ["introduction"],
            },
          ],
        }),
      },
      {
        tab: "API Reference",
        slug: "api",
        source: openapi("../api/openapi.yml"),
      },
    ],
  },
});

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the package.json scripts by running sourcey dev against the shown sourcey.config.ts, then investigate the reported unresolved Preact dependencies. Done means preview interactions such as Scrollspy, search, and dropdowns work without console or network errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devtools, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.