docs: Document regular expression searches

[claremacrae]

Description

Documentation

• New page docs/queries/regular-expressions.md
• Document regex searches for path, description and heading
• Quick Reference page updated

Sample vault:

• Tasks plugin in sample vault updated to support regex searches, for testing purposes
• New file:resources/sample_vaults/Tasks-Demo/Filters/Regular Expression Searches.md, with numerous examples of regex searches, and some interim notes on ideas for improvement.

Motivation and Context

To test and document the regex feature added in #790.

How has this been tested?

By viewing the docs in Obsidian, and by generating the docs site locally.

Screenshots (if appropriate)

Types of changes

Changes visible to users:

• [ ] Bug fix (prefix: fix - non-breaking change which fixes an issue)
• [ ] New feature (prefix: feat - non-breaking change which adds functionality)
• [ ] Breaking change (prefix: feat!! or fix!! - fix or feature that would cause existing functionality to not work as expected)
• [x] Documentation (prefix: docs - improvements to any documentation content)
• [x] Sample vault (prefix: vault - improvements to the Tasks-Demo sample vault)

Internal changes:

• [ ] Refactor (prefix: refactor - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
• [ ] Tests (prefix: test - additions and improvements to unit tests and the smoke tests)
• [ ] Infrastructure (prefix: chore - examples include GitHub Actions, issue templates)

Checklist

• [x] My code follows the code style of this project and passes yarn run lint.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.
• [ ] My change has adequate Unit Test coverage.

Terms

• [x] My contribution follow this project's contributing guide
• [x] I agree to follow this project's Code of Conduct

[claremacrae]

Hi Anna,

If you have time to have a look at this, I would be interested to know about anything that is obviously wrong.

Later on I will edit the examples section in the new regex page, to add a link to the new page in the sample vault - I plan to do that after this is merged, so I can check the URL.

[claremacrae]

Additionally, do the docs mention the sample vault? It seems like the examples in the sample vault would be a really useful resource here, and I am not sure people know about it.

Absolutely - that says better what I mean by this:

Later on I will edit the examples section in the new regex page, to add a link to the new page in the sample vault - I plan to do that after this is merged, so I can check the URL.

[AnnaKornfeldSimpson]

Additionally, do the docs mention the sample vault? It seems like the examples in the sample vault would be a really useful resource here, and I am not sure people know about it.

Absolutely - that says better what I mean by this:

Later on I will edit the examples section in the new regex page, to add a link to the new page in the sample vault - I plan to do that after this is merged, so I can check the URL.

Aha! I think I read that backwards earlier, that the sample vault was going to get an additional docs link later. The more links the better!

[claremacrae]

I'm merging this, even though there are some unresolved conversations. I'll pick up the outstanding conversations in a separate PR on a fresh branch.

[claremacrae]

All outstanding conversations in this PR have been resolved in #1051

[claremacrae]

It would have been quicker to implement regex search for tags than it was to test and document how to do it thoroughly via description 😢 ...