fix(sources): config-first sources, doc cleanup, audio skill#48
Merged
Conversation
…tion Replace the generic narration guidance with a deliberate, technique-based pipeline that produces spoken summaries a listener can follow and retain, instead of basic summaries read aloud. The TTS rendering pipeline is untouched; all changes target the narration script quality upstream. SKILL.md is restructured into an 8-step spine (capture intent, verify KB, search, choose format, write for listening, anchor memorability, render, report). Two reference files are added next to SKILL.md and bundled automatically: listening-style.md (pacing, TTS punctuation, anti-patterns) and narration-templates.md (skeletons per format, signposting and active-recall catalogues).
The previous chore added packages/*/dist/ to .gitignore but did not run git rm --cached, so 128 dist files (ragmir-core + ragmir-tts) inherited from the rebrand commit stayed tracked. .gitignore does not untrack already-tracked files retroactively. Untrack them now so the index matches the gitignore policy. The files stay on disk (rebuilt locally with pnpm build) and are no longer version controlled, consistent with the dist-as-build-output decision.
ragmir sources add/list now read and write the sources array of .ragmir/config.json instead of the legacy .ragmir/sources.txt file. This matches the config-first direction: ragmir init already stopped creating sources.txt, but sources add still wrote to it, leaving projects with an empty config sources array and all entries stranded in the legacy file. - addSourceEntries writes into config.json sources, preserving other fields. - listSourceEntries reads from config.json and merges a legacy sources.txt read-only when present, so existing projects keep working. - Never create or write sources.txt anymore. - Remove the now-unused SOURCES_FILE_HEADER from defaults.ts.
Clean up documentation that still presented the legacy kb binary and .kb/ paths as current, and sync the sources guidance with the new config-first behavior. - SECURITY-HARDENING.md: .kb/ to .ragmir/, kb destroy-index to ragmir destroy-index, .kb/config.json to .ragmir/config.json. - SECURITY.md: data boundary now favors .ragmir/, keeps .kb/ as legacy. - CHANGELOG.md: rewrite historical kb command names to ragmir with a legacy note; KB_INCLUDE_EXTENSIONS to RAGMIR_INCLUDE_EXTENSIONS. - README.md: sources.txt legacy note now matches sources.ts. Add a Mermaid diagram for the rawDir plus sources plus legacy merge flow. - AGENTS.md and docs/cli-reference.md: sources add/list target config.json.
jb-thery
force-pushed
the
feature/improve-text-tokenization
branch
from
f01719f to
8d6a668
Compare
dist/ is now gitignored build output, so ragmir-core can no longer rely on a committed ragmir-tts/dist to resolve the @jcode.labs/ragmir-tts import during typecheck and tests. In CI the check step runs before build, so the tts dist does not exist yet and tsc --noEmit fails with 'Cannot find module'. Make the core check and test scripts build ragmir-tts first, so the tts dist exists before core resolves it. This mirrors how pnpm build already orders tts before core.
|
🎉 This PR is included in version 2.2.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
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
1 participant
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.
Summary
Three logical changes on one branch: the intent-driven audio-summary skill, a sources.txt → config.json migration fix, and dead-doc cleanup.
Changes
dist/build output from the git index (the gitignore rule was added butgit rm --cachedwas missing, so 128 dist files stayed tracked).ragmir sources add/listnow read and write thesourcesarray in.ragmir/config.jsoninstead of the legacysources.txt. The legacy file is still read (read-only, merged) for backward compatibility but never created or written. Removes deadSOURCES_FILE_HEADER.kbreferences (SECURITY-HARDENING.md, SECURITY.md, CHANGELOG.md) and sync the sources.txt guidance in README/AGENTS.md/cli-reference.md with the new config-first behavior. Add a Mermaid diagram for the rawDir + sources + legacy merge flow.Checklist
pnpm lintcleanpnpm checkcleanpnpm test— 151/151pnpm smokegreen (CLI + MCP 8 tools)