docs: fix documentation errors found during review#14
Merged
Conversation
- Fix AGENTS.md: replace Ralphai references with dotai in Documentation Style section (copy-paste error from upstream Ralphai project) - Fix AGENTS.md: remove reference to non-existent src/ralphai.ts - Fix all 4 example files: frontmatter was unparseable by gray-matter due to HTML comments before the opening --- fence, broken YAML indentation, and backslash-escaped globs - Fix supported-targets.md: sync skill discovery list with actual prioritySearchDirs in src/skill-discovery.ts (10 stale entries removed, 4 missing entries added, redundant ./skills/ removed) - Remove broken self-referencing .ralphai symlink
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
src/ralphai.ts.examples/rule/RULES.md,examples/rule-with-overrides/RULES.md,examples/prompt/PROMPT.md, andexamples/agent/AGENT.mdall had HTML comments before the opening---fence (causing gray-matter to return{}), broken YAML indentation, and backslash-escaped globs. Fixed to valid, parseable YAML with comments moved to the body.supported-targets.mddiscovery list with source code — Removed 10 stale paths not insrc/skill-discovery.ts, added 4 missing paths, removed redundant./skills/entry, and added plugin manifest paths..ralphaisymlink — Self-referencing symlink tracked in git that pointed to itself (/home/mfaux/work/dotai/.ralphai -> /home/mfaux/work/dotai/.ralphai).Items reviewed and found correct
updateexists;syncis intentionally experimental/undocumented)npmin README vspnpmin AGENTS.md (end users vs contributors)