Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Major enhancements to Query File Defaults docs #3320

Merged
merged 36 commits into from
Feb 9, 2025
Merged

docs: Major enhancements to Query File Defaults docs #3320

merged 36 commits into from
Feb 9, 2025

Conversation

claremacrae
Copy link
Collaborator

@claremacrae claremacrae commented Feb 9, 2025 •
edited
Loading

Types of changes

Changes visible to users:

  • Bug fix (prefix: fix - non-breaking change which fixes an issue)
  • Documentation (prefix: docs - improvements to any documentation content for users)

Description

Documentation

  • Add new files:
    • docs/How To/Make a query user interface.md
    • docs/Other Plugins/Meta Bind Plugin.md
  • Edited:
    • docs/Queries/Query File Defaults.md
      • Major enhancements
    • docs/Queries/About Queries.md
      • Added descriptions to each link.
    • docs/Queries/Explaining Queries.md
      • Show how Query File Defaults are explained.
    • docs/Queries/Layout.md
      • Show how Query File Defaults can also change the layout.

Code

  • Trivial change to the explain output for Query File Defaults - capitalise those words - so they are consistent in the documentation.
  • Added tests to generate content for some of the docs changes above.

Motivation and Context

  • Getting ready to release

How has this been tested?

  • View the docs in Obsidian.
  • Use the Broken Links plugin to confirm that there are no broken links.

Checklist

Terms

@claremacrae
test: Add test data for 'explain' docs of Query File Defaults
7bf8477
@claremacrae
docs: Update 'Explaining Queries.md' to cover Query File Defaults
0fc0c63
@claremacrae
test: Machine-generate new markdown sample in 'Explaining Queries'
2e06cab
@claremacrae
docs: Machine-generate new markdown sample in 'Explaining Queries'
11bc98f
@claremacrae
test: - Introduce tasksFile parameter to verifyTaskBlockExplanation()
2a2c5fe
@claremacrae
test: Machine-generate new explanation sample in 'Explaining Queries'
2554f67
@claremacrae
docs: Machine-generate new explanation sample in 'Explaining Queries'
3fc3efd
@claremacrae
fix: Capitalise Query File Defaults in Explain output
3944433
@claremacrae
docs: Capitalise Query File Defaults in Explain output
60daecc
@claremacrae
docs: Refine Query File Defaults text in Explaining Queries.md
2d0e21b
@claremacrae
test: Fix a documentation sample that would obviously find no tasks
618ccc8 
Because query.file.path referenced a file with no tasks in.
@claremacrae
docs: Fix a documentation sample that would obviously find no tasks
f6bb253 
Because query.file.path referenced a file with no tasks in.
@claremacrae
docs: Add new pages 'Meta Bind Plugin.md' and 'Make a query user inte…
40ece38 
…rface.md'
@claremacrae
docs: 'Query File Defaults.md' now links to 'Make a query user interf…
56cde1e 
…ace'
@claremacrae
docs: Remove 'Meta Bind Query Widgets.md' which is no longer used
61d2fda
@claremacrae
docs: Add new pages to Changelog.md
da7fe1c
@claremacrae
docs: Explain motivation of Meta Bind ui
3379fa4
@claremacrae
docs: Document that Canvas cards do not support Query File Defaults
49d6c16
@claremacrae
docs: Make 'Query Properties.md' link to 'Query File Defaults.md'
f60abb8
@claremacrae
docs: Note that Query File Defaults can control layouts
aa3d36c
@claremacrae
tests: Machine-generate new sample for Query File Defaults docs
d387f2a
@claremacrae
docs: Note in Layout.md that Query File Defaults and Meta Bind can ad…
c9df3cb 
…just layout
@claremacrae
docs: Provide more info on TQ_short_mode
c26e004
@claremacrae
docs: Provide more info on TQ_show_tree
81f1651
@claremacrae
docs: Provide more info on TQ_extra_instructions
c6f2eba
@claremacrae
docs: Fix typo
480c09a
@claremacrae
docs: Explain the type values in Query File Defaults.md
734195e
@claremacrae
docs: Try to better convey the power of Query File Defaults
647b9ba
@claremacrae
docs: TQ_extra_instructions cannot contain line continuations
d34de1a
@claremacrae
docs: 'About Queries.md' now links to 'Query File Defaults.md'
52958d0
@claremacrae claremacrae added the scope: documentation Improvements or additions to documentation label Feb 9, 2025
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Feb 9, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@claremacrae claremacrae changed the title docs: Major enhancements to Query File Defaults documentation docs: Major enhancements to Query File Defaults docs Feb 9, 2025
@claremacrae claremacrae merged commit bad8939 into main Feb 9, 2025
4 checks passed
@claremacrae claremacrae deleted the docs-query-file-defaults branch February 9, 2025 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@claremacrae