docs: fix references to things that do not exist - #13
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Three unrelated accuracy problems, all found by checking documentation
against the tree.
1. README describes a `_config/` folder that does not exist
README.md:75 puts `_config/` in the canonical workspace layout and
README.md:82 calls it a Layer 3 location. There is no `_config/`
directory anywhere in the repo:
$ find . -type d -name '_config' | wc -l
0
The real Layer 3 config folders are `brand-vault/` (script-to-animation,
voice-driven-animation) and `design-system/` (course-deck-production),
which is what _core/CONVENTIONS.md:25 already says. Updated the README to
match the convention the workspaces actually follow.
2. conventions-reference.md skips Pattern 8
The file enumerates Patterns 1-7 and 9-15. Pattern 8 (Questionnaire
Design) is missing. This matters because stage 01-discovery loads this
file as "Full file" to "know the ICM patterns", and stage
04-questionnaire-design is the stage that needs Pattern 8 most. Added the
entry in the same one-line-summary-plus-pointer style as its neighbours.
3. .gitignore has no __pycache__ rule
The repo ships 15 Python scripts across the bundled pptx, elevenlabs and
whisper skills. Running any of them leaves untracked __pycache__/
directories in git status. Added __pycache__/ and *.pyc.
Verified: 0 remaining `_config` references in the README against 3 real
config dirs; Patterns 1-15 all present in conventions-reference.md; and the
gitignore rule tested by creating a real __pycache__ directory and
confirming git status stays clean.
Author
|
Correction on merge conflicts. My PR description mentioned a single one-line conflict. Having actually merged all five locally, there are three. Recording the exact resolutions so none of this costs you time. Recommended order: #10 -> #11 -> #12 -> #13 -> #14. Each is independently mergeable; only the later ones need a touch.
All three are "keep both sides" -- no judgment needed, nothing is dropped. Verified end state with all five applied and conflicts resolved as above: If you would rather not deal with any of this, say the word and I will collapse all five into a single PR, or rebase them into a stack so they apply in order with no conflicts at all. |
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.
Three unrelated accuracy problems, all found by checking the documentation against the tree.
1. The README describes a
_config/folder that does not existREADME.md:75puts_config/in the canonical workspace layout andREADME.md:82calls it a Layer 3 location.The real Layer 3 config folders are
brand-vault/(script-to-animation, voice-driven-animation) anddesign-system/(course-deck-production), which is what_core/CONVENTIONS.md:25already says correctly. The README is the file that disagrees.2.
conventions-reference.mdskips Pattern 8The file enumerates Patterns 1-7 and 9-15. Pattern 8 (Questionnaire Design) is absent.
This matters because
stages/01-discoveryloads this file as "Full file" to "know the ICM patterns", andstages/04-questionnaire-designis the stage that needs Pattern 8 most. Added in the same one-line-summary-plus-pointer style as its neighbours.3.
.gitignorehas no__pycache__ruleThe repo ships 15 Python scripts across the bundled pptx, elevenlabs and whisper skills. Running any of them leaves untracked
__pycache__/directories ingit status. Added__pycache__/and*.pyc.Verification
0 remaining
_configreferences in the README against 3 real config dirs; Patterns 1-15 all present; and the gitignore rule tested by creating a real__pycache__directory and confirminggit statusstays clean.