Skip to content

docs: wiki pages and sync script - #8

Open
JDeffner wants to merge 2 commits into
chore/release-2.0from
docs/wiki
Open

JDeffner wants to merge 2 commits into
chore/release-2.0from
docs/wiki

Conversation

@JDeffner

@JDeffner JDeffner commented Sep 5, 2026 •

Copy link
Copy Markdown
Owner

Adds the GitHub wiki as 16 pages plus _Sidebar.md and _Footer.md under
docs/wiki/, so the docs are reviewed like code instead of edited in the
wiki UI.

  • Use it: Getting Started, Installation and Builds, UI Component, Voice Input, Framework Guides
  • Configure: Providers, Running a Proxy, Form Fields and Hints, Events Results and Review
  • Understand: Architecture, Security and Privacy, Errors and Troubleshooting
  • Contribute: Contributing, Releasing, FAQ and Non-Goals

scripts/sync-wiki.mjs (zero dependencies) clones the wiki repo, replaces its
Markdown with docs/wiki/*.md and pushes; pnpm wiki:sync runs it, and
CONTRIBUTING says when to.

🤖 Generated with Claude Code

Summary by Sourcery

Manage the GitHub wiki as reviewed repository documentation and provide a maintainer-only command to publish it.

Enhancements:

  • Add a comprehensive, repository-managed GitHub wiki covering usage, configuration, architecture, troubleshooting, security, and contribution workflows.

Build:

  • Add the pnpm wiki:sync command for publishing repository-authored wiki content.

Documentation:

  • Document the wiki authoring and synchronization workflow in the contributor guide and expand the README usage example.

Chores:

  • Add a dependency-free script that synchronizes Markdown pages with the GitHub wiki repository.

Sixteen wiki pages plus the sidebar and footer under docs/wiki/, authored
in the repo so they go through review. scripts/sync-wiki.mjs pushes them
to the GitHub wiki repository; `pnpm wiki:sync` runs it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @JDeffner, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 3 days and 10 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Reviewer's Guide

This PR moves the GitHub wiki into version-controlled Markdown under docs/wiki/, adds 18 navigated documentation pages, and provides a maintainer-only pnpm wiki:sync workflow that replaces and pushes the wiki contents from the repository.

Sequence diagram for syncing repository documentation to the GitHub wiki

sequenceDiagram
    participant Maintainer
    participant Script as sync-wiki.mjs
    participant Repo as Repository
    participant Wiki as GitHub Wiki

    Maintainer->>Script: pnpm wiki:sync
    Script->>Repo: readdirSync(docs/wiki)
    Script->>Repo: git rev-parse --short HEAD
    Script->>Wiki: git clone --depth 1
    Script->>Wiki: Remove existing Markdown files
    Script->>Wiki: Copy docs/wiki/*.md
    Script->>Wiki: git add -A
    alt Content changed
        Script->>Wiki: git commit
        Script->>Wiki: git push
    else Content unchanged
        Script-->>Maintainer: Wiki already up to date
    end
    Script-->>Maintainer: Remove temporary clone
Loading

File-Level Changes

Change Details Files
Adds a repository-authored GitHub wiki with structured navigation and comprehensive usage, configuration, architecture, troubleshooting, security, and contribution guidance.
  • Adds the Home page, sidebar, footer, and topic pages covering installation, UI, voice, frameworks, providers, proxying, form behavior, events, architecture, security, troubleshooting, releases, and FAQs.
  • Uses consistent GitHub wiki page links and documents the supported APIs, workflows, limitations, and operational practices.
docs/wiki/Home.md
docs/wiki/_Sidebar.md
docs/wiki/_Footer.md
docs/wiki/Getting-Started.md
docs/wiki/Installation-and-Builds.md
docs/wiki/UI-Component.md
docs/wiki/Voice-Input.md
docs/wiki/Framework-Guides.md
docs/wiki/Providers.md
docs/wiki/Running-a-Proxy.md
docs/wiki/Form-Fields-and-Hints.md
docs/wiki/Events-Results-and-Review.md
docs/wiki/Architecture.md
docs/wiki/Security-and-Privacy.md
docs/wiki/Errors-and-Troubleshooting.md
docs/wiki/Contributing.md
docs/wiki/Releasing.md
docs/wiki/FAQ-and-Non-Goals.md
Introduces a zero-dependency script and package command to synchronize repository wiki Markdown into the GitHub wiki repository.
  • Discovers Markdown pages under docs/wiki/, clones the wiki shallowly into a temporary directory, removes existing Markdown, copies the authored pages, and commits/pushes only when content changed.
  • Uses the current repository commit in the sync commit message and always cleans up the temporary clone.
scripts/sync-wiki.mjs
package.json
Documents the wiki authoring and synchronization workflow for contributors and maintainers.
  • Adds the wiki sync command to the contributor script table.
  • Explains that wiki edits must happen under docs/wiki/ and that maintainers run the sync after merging.
CONTRIBUTING.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant