docs: spektorAI canonical front door + WhisperForge handbook rename#58
Merged
Conversation
…eep source-available Resolve the spektorAI/WhisperForge naming split and the README case collision before publishing the house-style front-door docs. - name: spektorAI is the public/project name; WhisperForge stays the engine (whisperforge_core, the services, the handbook). project.yaml name follows. - readme.md -> WHISPERFORGE.md (git mv, history + links preserved): the detailed engine handbook. kills the case-insensitive README.md clash and keeps long-form docs at root, matching ROADMAP/STATUS/changelog. - add house-style README.md (front door), AGENTS.md, llms.txt in KK voice. - license unchanged: no OSS license granted, source-available only, no MIT. - repoint docs_truth_check.py + docs-truth.yml at README.md/WHISPERFORGE.md; make docs-check passes (18 docs, 15 targets). Pre-existing local WIP (ROADMAP, STATUS, services, tests, ui, whisperforge_core) deliberately left unstaged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Resolves the spektorAI/WhisperForge naming split and the README case collision before the house-style front-door docs go live.
Canonical name: spektorAI (WhisperForge = the engine)
Two-tier identity instead of renaming code:
project.yamlname, repo description).whisperforge_core, the FastAPI services, the handbook). Left as-is, renaming it would be a large breaking change and the services genuinely are WhisperForge's.README files: rename, not fold or replace
git mv readme.md WHISPERFORGE.md(100% rename, history + links preserved). Kills the case-insensitiveREADME.md/readme.mdcollision and keeps long-form docs at root, matchingROADMAP/STATUS/changelog.docs/would have broken all 7 of the handbook's root-relative links (the doc-truth checker resolves links per file); replacing would have destroyed 561 lines of engine docs.README.md(front door),AGENTS.md,llms.txtin KK voice (no em dashes).License: unchanged
No OSS license granted, source-available only, no MIT. Verified: no
LICENSEtracked, GitHublicenseInfonull.Doc-truth coupling
scripts/docs_truth_check.py+.github/workflows/docs-truth.ymlrepointed atREADME.md/WHISPERFORGE.md.make docs-checkpasses (18 docs, 15 targets).Note: pre-existing local WIP (
ROADMAP,STATUS,services,tests,ui,whisperforge_core) was deliberately left out of this PR.🤖 Generated with Claude Code