docs: fix stale voicepoc references and dev-setup instructions - #18
Open
jlocala1 wants to merge 1 commit into
Open
docs: fix stale voicepoc references and dev-setup instructions#18jlocala1 wants to merge 1 commit into
jlocala1 wants to merge 1 commit into
Conversation
The repo was renamed from voicepoc- to pulseclip but the docs still told users to 'cd voicepoc-'. Also corrects instructions that no longer match the code: - clone/cd steps use the real repo URL and folder name - mark the server/.env step required (without it the server defaults to port 3000 and collides with the client dev server) - transcription auto-starts after upload; document the >100MB async flow and the /api/transcribe/status/:jobId polling endpoint - curl examples use artipod URLs instead of removed /uploads routes - drop the stale 500MB limit (removed in mieweb#16); add troubleshooting entries for placeholder API key and locally-missing featured pulses - production serve section: npm run prod, Express serves client/dist - rename root package voicepoc -> pulseclip
jlocala1
force-pushed
the
fix/dev-setup-docs
branch
from
July 23, 2026 14:26
94a08fa to
511072b
Compare
Author
|
Trimmed to docs-only — the /artipods Vite proxy landed on main via the #22 lineage, so that commit dropped out on rebase. What's left: voicepoc→pulseclip rename in package.json, real clone URL, current endpoint docs (artipods + async-transcription polling), the .env port-collision note, and the featured-pulses local-404 note. Independently mergeable. |
jlocala1
force-pushed
the
fix/dev-setup-docs
branch
from
August 3, 2026 20:35
511072b to
f36b8f7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following the README on a fresh clone currently fails in a few places. This PR makes the documented setup path actually work, verified end-to-end on a clean checkout (install → upload → playback in the browser).
The bug (commit 1): in dev mode the media player is broken for every upload. The client requests media at
/artipods/{id}/{file}, butvite.config.tsonly proxies/apiand/uploads— so Vite's SPA fallback answers withindex.html(a 200 withtext/html), and the player shows "Unable to load media. The server may be unavailable." Easy to miss because the network tab shows all 200s. Fix: proxy/artipodsto the API server like the other routes.The docs (commit 2):
cd voicepoc-→cd pulseclipin README/USAGE (leftover from the repo's original name; there is no such directory after cloning)server/.envstep as required — without it the server defaults to port 3000 and collides with the Vite dev serverGET /api/transcribe/status/:jobId(from feat: async transcription for large files with polling UI #17)/uploads/file.mp3form no longer matches how/api/transcriberesolves files)npm run prod— Express already servesclient/distitselfvoicepoc→pulseclip(package.json + lockfile)No behavior changes outside the dev proxy; server code untouched.