diff --git a/.eslintignore b/.eslintignore index 095c412..ce3698e 100644 --- a/.eslintignore +++ b/.eslintignore @@ -49,4 +49,7 @@ compile-migration.js import-meta-url-shim.js # Obsidian -.obsidian \ No newline at end of file +.obsidian + +# Markdown +*.md diff --git a/.prettierignore b/.prettierignore index fa4838f..7037437 100644 --- a/.prettierignore +++ b/.prettierignore @@ -48,3 +48,6 @@ manifest.json # Obsidian .obsidian + +# Markdown +*.md diff --git a/README.md b/README.md index b8b6d55..3264af8 100644 --- a/README.md +++ b/README.md @@ -93,27 +93,20 @@ Smart Composer adds a few commands to work with AI. You can set custom hotkeys f 3. Place the downloaded files into this new folder. 4. Open Obsidian settings `Settings > Community plugins`, and enable Smart Composer. -## Roadmap - -#### Expanded Context Support - -- [x] Folder context mentioning, and auto context selection (RAG) -- [x] Web content browsing -- [ ] PDF, DOCX, and image understanding -- [ ] Mention Obsidian tag +### Troubleshooting -#### Advanced Search +Smart Composer requires a recent version of the Obsidian installer. If you experience installation issues, please ensure your Obsidian is updated to the latest version. To check your Obsidian version, navigate to `Settings > General > Check for updates`. -- [x] Chat with AI to find specific notes or content - -#### Prompt Presets +## Roadmap -- [ ] Save and reuse custom prompts for common tasks +To see our up-to-date project roadmap and progress, please check out our [GitHub Projects kanban board](https://github.com/glowingjade/obsidian-smart-composer/projects?query=is%3Aopen). -#### Tab Completion +Some of our planned features include: -- [ ] Copilot-like autocomplete -- [ ] Context-aware suggestions based on your writing style and vault content +- Support for other models, including local models +- Support for image inputs or external files (PDF, DOCX, etc.) +- Custom prompt templates and system prompts +- Mentioning with tags or other metadata ## Feedback and Support @@ -131,6 +124,8 @@ Your feedback and experiences are crucial in making Smart Composer better for ev We welcome all kinds of contributions to Obsidian Smart Composer, including bug reports, bug fixes, documentation improvements, and feature enhancements. +**For major feature ideas, please create an issue first to discuss feasibility and implementation approach.** + If you're interested in contributing, please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed information on: - Setting up the development environment @@ -139,7 +134,6 @@ If you're interested in contributing, please refer to our [CONTRIBUTING.md](CONT - The process for submitting pull requests - Known issues and solutions for developers -For major feature ideas, please create an issue first to discuss feasibility and implementation approach. ## License