-
Notifications
You must be signed in to change notification settings - Fork 1
feat: add learning plugin + obsidian study/project-doc #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arevlo-flow
wants to merge
1
commit into
arevlo:main
Choose a base branch
from
arevlo-flow:arevlo.feat-add-learning-and-obsidian-commands
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "name": "arevlo:learning", | ||
| "description": "Personal learning tools — vocabulary lookup and grammar/punctuation rules, in English and Spanish.", | ||
| "version": "2.0.0" | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Learning Plugin | ||
|
|
||
| Personal learning tools for vocabulary lookup and grammar/punctuation rules. Supports English and Spanish. | ||
|
|
||
| ## Commands | ||
|
|
||
| ### `/arevlo:learning:vocab` | ||
|
|
||
| Look up a word — definition, pronunciation, and a simple example. | ||
|
|
||
| **Usage:** | ||
| ``` | ||
| /arevlo:learning:vocab <word> | ||
| /arevlo:learning:vocab es <word> | ||
| ``` | ||
|
|
||
| - Default language is English | ||
| - Prefix with `es` for Spanish lookups | ||
| - Uses web search to find definitions from authoritative dictionaries | ||
|
|
||
| ### `/arevlo:learning:grammar` | ||
|
|
||
| Look up a grammar or punctuation rule — usage, examples, and common mistakes. | ||
|
|
||
| **Usage:** | ||
| ``` | ||
| /arevlo:learning:grammar <rule or punctuation mark> | ||
| /arevlo:learning:grammar es <rule> | ||
| ``` | ||
|
|
||
| - Default language is English | ||
| - Prefix with `es` for Spanish lookups | ||
| - Covers grammar rules, punctuation marks, commonly confused words | ||
|
|
||
| ## Installation | ||
|
|
||
| This plugin is part of the `claude-code-workflows` marketplace. | ||
|
|
||
| 1. Add the marketplace to `~/.claude.json`: | ||
| ```json | ||
| { | ||
| "extraKnownMarketplaces": { | ||
| "claude-code-workflows": { | ||
| "source": { | ||
| "source": "github", | ||
| "owner": "arevlo", | ||
| "repo": "claude-code-workflows" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 2. Enable the plugin in `~/.claude/settings.json`: | ||
| ```json | ||
| { | ||
| "enabledPlugins": { | ||
| "arevlo:learning@claude-code-workflows": true | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 3. Restart Claude Code or run `/plugins refresh` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| description: Look up a grammar or punctuation rule — usage, examples, and common mistakes (English/Spanish) | ||
| argument-hint: "[es] <rule or punctuation mark>" | ||
| allowed-tools: WebSearch,WebFetch | ||
| model: haiku | ||
| --- | ||
|
|
||
| # Grammar & Punctuation Lookup | ||
|
|
||
| Look up a grammar or punctuation rule and display practical guidance with real-world examples. Supports English (default) and Spanish. | ||
|
|
||
| ## Process | ||
|
|
||
| 1. Extract the arguments. If no arguments were provided, ask the user what grammar rule or punctuation mark they want to look up. Suggest a few examples: | ||
| - English: semicolons, em dashes, oxford comma, who vs whom, affect vs effect | ||
| - Spanish: punto y coma, tilde, signos de interrogacion, por que vs porque, ser vs estar | ||
|
|
||
| 2. **Detect language:** Check if the first token is `es` (case-insensitive). If so, the language is **Spanish** and the topic is everything after `es`. Otherwise, the language is **English** and the entire argument is the topic. | ||
|
|
||
| 3. **Search for the rule:** | ||
|
|
||
| **English:** Use WebSearch to search for: `<topic> grammar rule usage examples site:grammarly.com OR site:owl.purdue.edu OR site:chicagomanualofstyle.org` | ||
| Then use WebFetch on the most relevant result to get the full explanation. | ||
|
|
||
| **Spanish:** Use WebSearch to search for: `<topic> regla gramatical uso ejemplos site:dle.rae.es OR site:fundeu.es OR site:wikilengua.org` | ||
| Then use WebFetch on the most relevant result to get the full explanation. | ||
|
|
||
| 4. **Format the output:** | ||
|
|
||
| **English format:** | ||
|
|
||
| ``` | ||
| ## <topic> | ||
|
|
||
| **What it is:** <one-sentence description of the rule or mark> | ||
|
|
||
| **When to use it:** | ||
| - <most common use case> | ||
| - <second common use case> | ||
| - <third common use case, if relevant> | ||
|
|
||
| **Examples:** | ||
| - <correct usage> — <brief explanation> | ||
| - <correct usage> — <brief explanation> | ||
|
|
||
| **Common mistakes:** | ||
| - <wrong usage> -> <corrected version> | ||
| - <wrong usage> -> <corrected version> | ||
|
|
||
| **Quick tip:** <one memorable takeaway> | ||
| ``` | ||
|
|
||
| **Spanish format:** | ||
|
|
||
| ``` | ||
| ## <tema> | ||
|
|
||
| **Que es:** <descripcion en una oracion de la regla o signo> | ||
|
|
||
| **Cuando se usa:** | ||
| - <caso de uso mas comun> | ||
| - <segundo caso de uso comun> | ||
| - <tercer caso de uso, si aplica> | ||
|
|
||
| **Ejemplos:** | ||
| - <uso correcto> — <breve explicacion> | ||
| - <uso correcto> — <breve explicacion> | ||
|
|
||
| **Errores comunes:** | ||
| - <uso incorrecto> -> <version corregida> | ||
| - <uso incorrecto> -> <version corregida> | ||
|
|
||
| **Consejo rapido:** <un dato memorable para recordar> | ||
| ``` | ||
|
|
||
| ## Rules | ||
|
|
||
| - Be practical over exhaustive — focus on the 2-3 most useful things to know | ||
| - Use real-world examples, not textbook-sounding ones | ||
| - Always highlight common mistakes — that's where the most value is | ||
| - Keep the quick tip memorable and actionable | ||
| - **English lookups:** all output in English | ||
| - **Spanish lookups:** all output entirely in Spanish (labels, explanations, examples — everything) | ||
| - Do NOT save anything to a file — just display the result in the terminal |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| description: Look up a word — definition, pronunciation, and simple example (English/Spanish) | ||
| argument-hint: "[es] <word>" | ||
| allowed-tools: WebSearch,WebFetch | ||
| model: haiku | ||
| --- | ||
|
|
||
| # Vocabulary Lookup | ||
|
|
||
| Look up a word and display its definition, pronunciation, and a simple example. Supports English (default) and Spanish. | ||
|
|
||
| ## Process | ||
|
|
||
| 1. Extract the arguments. If no arguments were provided, ask the user what word they want to look up. | ||
|
|
||
| 2. **Detect language:** Check if the first token is `es` (case-insensitive). If so, the language is **Spanish** and the word is everything after `es`. Otherwise, the language is **English** and the entire argument is the word. | ||
|
|
||
| 3. **Search for the word:** | ||
|
|
||
| **English:** Use WebSearch to search for: `"<word>" definition pronunciation dictionary` | ||
| Then use WebFetch on the most relevant dictionary result (prefer Merriam-Webster, Dictionary.com, or Oxford) to get the full entry. | ||
|
|
||
| **Spanish:** Use WebSearch to search for: `"<word>" definicion pronunciacion diccionario site:dle.rae.es OR site:spanishdict.com OR site:wordreference.com` | ||
| Then use WebFetch on the most relevant result (prefer RAE, SpanishDict, or WordReference) to get the full entry. | ||
|
|
||
| 4. **Format the output:** | ||
|
|
||
| **English format:** | ||
|
|
||
| ``` | ||
| ## <word> | ||
|
|
||
| **Pronunciation:** /<phonetic spelling>/ | ||
|
|
||
| **Part of speech:** <noun, verb, adjective, etc.> | ||
|
|
||
| **Definition:** <clear, concise definition — prefer the most common meaning> | ||
|
|
||
| **Example:** <a simple sentence a middle-schooler would understand> | ||
| ``` | ||
|
|
||
| **Spanish format:** | ||
|
|
||
| ``` | ||
| ## <word> | ||
|
|
||
| **Pronunciacion:** /<transcripcion fonetica>/ | ||
|
|
||
| **Categoria gramatical:** <sustantivo, verbo, adjetivo, etc.> | ||
|
|
||
| **Definicion:** <definicion clara y concisa — preferir el significado mas comun> | ||
|
|
||
| **Ejemplo:** <una oracion sencilla que un estudiante de secundaria entenderia> | ||
| ``` | ||
|
|
||
| ## Rules | ||
|
|
||
| - Keep it short — one primary definition, one example | ||
| - If the word has multiple parts of speech, show the most common one | ||
| - The example sentence should be straightforward and relatable for a ~12 year old | ||
| - If the word is not found, say so clearly | ||
| - **English lookups:** all output in English | ||
| - **Spanish lookups:** all output entirely in Spanish (labels, definition, example — everything) | ||
| - Do NOT save anything to a file — just display the result in the terminal |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| { | ||
| "name": "arevlo:obsidian", | ||
| "description": "Capture screenshots and context to Obsidian Zettelkasten vault as fragment notes. Save external links to note tables.", | ||
| "version": "1.2.1" | ||
| "description": "Capture screenshots and context to Obsidian Zettelkasten vault as fragment notes. Save external links to note tables. Interactively study complex documents with Q&A. Add Confluence document summaries to project files.", | ||
| "version": "1.6.0" | ||
| } |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section says the vault path in
~/.claude/obsidian-plugin.jsonis used by all commands and that any command will prompt to set it up, but/arevlo:obsidian:capturestill hardcodesVAULT_PATHinplugins/obsidian/commands/capture.mdwithout reading the config. If a user follows this README and sets a custom vault path, capture will write to the hardcoded location or fail, so the documentation is misleading and the command won’t work as described. Either update capture to read the config or narrow the README claim to only the new commands.Useful? React with 👍 / 👎.