Skip to content

Commit d48284e

Browse files
docs: fix notifications, update auto-suggest (#1005)
* docs: Update Notifications page to note curernt Reminders interop issues * docs(internal): Brief writeup on docs dependency updates * docs: Add auto-suggest FAQ about working with other plugins that have auto-suggest
1 parent f79824d commit d48284e

File tree

3 files changed

+53
-4
lines changed

3 files changed

+53
-4
lines changed

docs/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,13 @@ If you can run docker, this is the easiest way.
4949
5050
### Seeing the docs via Docker
5151
52-
Now every time you want to see the docs locally, run:
52+
> Note: If using Windows, there are some interoperability issues with Windows, Docker, and Jekyll.
53+
> Recommend running the command below from a Windows Subsystem for Linux (WSL) shell,
54+
> where you can likely get to your Windows user directory via `/mnt/c/Users/<your username>`,
55+
> and using a browser from inside WSL2 if possible. Otherwise, if running the browser from Windows,
56+
> at every page load you must change "0.0.0.0" to "localhost" in the browser's address bar.
57+
58+
To see the docs locally, run:
5359
5460
```bash
5561
cd obsidian-tasks/docs
@@ -108,3 +114,15 @@ bundle exec jekyll serve
108114

109115
In the output, look for the line containing `Server address:` and open that URL in your local browser.
110116
It will be something like <http://0.0.0.0:4000/obsidian-tasks/>.
117+
118+
## Dependency Management and Updates for the Docs
119+
120+
The dependencies for running the docs locally are stored in the `Gemfile` (short, equivalent to Javascript `package.json`) and `Gemfile.lock` (auto-generated, equivalent to `yarn.lock`) files.
121+
The package manager (equivalent to "yarn") is "bundle" [docs here](https://bundler.io/guides/using_bundler_in_applications.html#recommended-workflow). The "docker_start" script runs the initial
122+
`bundle install` when building the Docker image.
123+
If seeing issues with dependencies or with running the docs locally, check that the versions in the `Gemfile`, especially "github-pages" are up-to-date. If making edits to the `Gemfile`, you
124+
will need to run `bundle install` or `bundle update` manually. (You may also need to update `bundle` itself!) Before checking in any changes to `Gemfile.lock`, see the paragraph below.
125+
126+
Some dependencies, such as "nokogiri", have platform-specific gems that **should not** be checked into the repo's `Gemfile.lock`.
127+
For example, Dependabot might add a Linux-specific version of a dependency to the `Gemfile.lock`, which must then be manually edited to remove the Linux-specific version.
128+
Otherwise, future contributors on non-Linux systems will be unable to build the Docker image or run Jekyll locally.

docs/advanced/notifications.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,35 @@ _Note that this is a screenshot of the reminder plugin's settings and not Tasks.
1818

1919
## Where to add the reminder date
2020

21-
The order is important when writing the task. You have to put the reminder date between the task name and the other fields :
21+
The order is important when writing the task. Tasks requires the reminder date after the task description and before any other Tasks fields. Reminders [requires no content between the reminder date and the due date](https://uphy.github.io/obsidian-reminder/guide/interop-tasks.html#distinguish-due-date-and-reminder-date).
2222

2323
```markdown
24-
- [ ] #task task name ⏰ YYYY-MM-DD HH:mm 🔁 every *** 🛫 YYYY-MM-DD ⏳ YYYY-MM-DD 📅 YYYY-MM-DD
24+
- [ ] #task task name ⏰ YYYY-MM-DD HH:mm 📅 YYYY-MM-DD ⏫ 🔁 every week 🛫 YYYY-MM-DD ⏳ YYYY-MM-DD
2525
```
2626

27+
---
28+
29+
Warning
30+
{: .label .label-yellow}
31+
The output of the "Create or Edit Tasks" command will not put the due date directly behind the reminder date where Reminders wants it.
32+
You must fix this manually if you want to use the Reminders "defer" command;
33+
**otherwise (as of August 2022), using the Reminders "defer" command will overwrite all information between the ⏰ and 📅 emoji!**
34+
See [this issue in Reminders to check the current status](https://github.com/uphy/obsidian-reminder/issues/100).
35+
36+
---
37+
2738
## How to complete the reminder
2839

29-
The reminder date doesn't change when completing the task as of yet, the date will change only when you complete it from the reminder popup or from the notification.
40+
The reminder date doesn't change when completing the task, the date will change only when you complete it from the reminder popup or from the notification.
3041

3142
![image](https://user-images.githubusercontent.com/38974541/143463881-e4af4b91-426f-48e8-938e-4a1053b06677.png)
3243
![image](https://user-images.githubusercontent.com/38974541/143464983-542675ae-a467-41c0-aaca-1075c42f8328.png)
44+
45+
---
46+
47+
Warning
48+
{: .label .label-yellow}
49+
Completing recurring tasks does not work correctly with Reminders as of August 2022.
50+
See [this issue in Reminders to check the current status](https://github.com/uphy/obsidian-reminder/issues/93).
51+
52+
---

docs/getting-started/auto-suggest.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,17 @@ Similarly, you can type some fraction of the word `start` (of whatever length is
223223
| next month (2022-08-11) | 2022-08-11 |
224224
| next year (2023-07-11) | 2023-07-11 |
225225

226+
### How can I use auto-suggest features from other plugins together with the Tasks auto-suggest?
227+
228+
Obsidian plugins such as Tasks cannot tell if you have auto-suggest features from other plugins enabled.
229+
Therefore it is user responsibility to manage conflicts between auto-suggest features.
230+
231+
The Tasks auto-suggest will only appear on lines that start `- [ ]` and contain the global filter (if one is set).
232+
If you want to use auto-suggest features from another plugin on such lines, make sure that plugin's settings for auto-suggest
233+
appearance do not overlap with the keywords listed above,
234+
then increase the 'Minimum match length for auto-suggest' value in the Tasks settings to more characters than used to activate the other plugin's auto-suggest,
235+
and re-start Obsidian.
236+
226237
## Settings
227238

228239
Note that like all Tasks settings, after any changes, Obsidian needs to be restarted for the new settings to take effect.

0 commit comments

Comments
 (0)