Commit graph

25 commits

Author SHA1 Message Date
callumalpass
3a27991755 document canvas bases companion plugin 2026-06-10 07:10:01 +10:00
callumalpass
bf5a68019a checkpoint runtime api and companion docs 2026-06-01 19:19:26 +10:00
callumalpass
99cb64e726 Add runtime API and materialized occurrence calendar handling 2026-05-31 22:32:12 +10:00
callumalpass
0838eae6e9 Add spec landing page and cross-references
Add docs/spec.md as a landing page for the specification section with
a section index, conformance summary, and implementer guidance. Link
to it from the home page quick links and from core-concepts field
mapping section. Update nav to include the landing page.
2026-03-29 19:38:46 +11:00
callumalpass
fc6a1fbe1d Add tasknotes-spec as submodule and wire up docs nav
Add the specification repo as a git submodule at docs/spec and add
a Specification nav section in mkdocs.yml pointing at all spec files.
2026-03-29 19:31:09 +11:00
callumalpass
9298cc8d59 Document TaskNotes Obsidian CLI commands 2026-03-29 19:31:09 +11:00
callumalpass
735706ead4 docs: tighten accuracy, fix cross-links, and consolidate unreleased notes 2026-02-21 13:41:32 +11:00
callumalpass
b0cd74f1ad docs: update docs content and docs build tooling 2026-02-21 08:52:08 +11:00
callumalpass
9f58230570 Add mdbase-tasknotes CLI documentation
New doc page covering the standalone mtn CLI: installation, setup with
existing vaults, NLP task creation, querying, time tracking, and a
comparison table explaining when to use mtn vs tasknotes-cli.
Also adds release note entry for the new tool.
2026-02-15 14:09:32 +11:00
callumalpass
291184cd56 docs: restructure task management guides and refresh screenshots
Split recurring tasks and reminders content into dedicated pages,
condense existing guides for clarity, and update all documentation
screenshots. Refactor e2e screenshot tests with shared openView()
helper and retry support. Refine MdbaseSpec field types (enum,
datetime, link) and replace MCPService @ts-expect-error workarounds
with bound tool pattern.
2026-02-15 12:10:28 +11:00
callumalpass
413df27517 chore(docs): add docs sync and CI quality checks 2026-02-15 11:03:35 +11:00
callumalpass
45b752101c docs: add comprehensive template variables reference
Consolidates documentation for all 70+ template variables in one
reference document, covering body templates, folder templates, and
filename templates with examples and availability matrix.
2026-01-07 21:18:38 +11:00
callumalpass
ed6f913b16 docs: Add missing nav link to Default Base Templates page (#1295)
The Default Base Templates page existed but was not accessible from
the site navigation. Added the page to the Views section in mkdocs.yml.
2026-01-01 17:52:52 +11:00
callumalpass
5708d3dd9d docs: consolidate and streamline documentation
- Add v3 to v4 migration guide with Bases setup instructions
- Expand core-concepts.md with YAML structure, property types, and methodology examples
- Streamline index.md to be a concise landing page with quickstart
- Remove developer-focused timezone docs (TIMEZONE_HANDLING_*.md)
- Update releases.md to show v4.x as current
- Fix broken relative links in features.md
- Reduce repetition across docs by centralizing Bases info in core-concepts.md
- Consolidate task-management.md recurring tasks and reminders sections
- Simplify features/integrations.md and features/calendar-integration.md
- Reduce task-defaults.md Default Reminders section from 227 to 24 lines
- Add v4/Bases troubleshooting and OAuth calendar troubleshooting sections
- Update troubleshooting.md with current settings paths and GitHub link
- Update calendar-setup.md with Azure manifest redirect URI instructions
2025-12-07 13:03:21 +11:00
callumalpass
855c301848 docs: add property types reference documentation (#1259)
Add comprehensive documentation for frontmatter property types to help
users understand expected data formats when creating tasks via templates
or manual editing.
2025-11-30 15:49:21 +11:00
callumalpass
fe92698b03 Fix: Resolve base template generation issues (#1145, #1156)
- Fix Kanban template missing groupBy property
  * Default Kanban now includes groupBy on status field
  * Resolves error requiring manual group configuration
  * Thanks to @randomness42 and @seepage87 for reporting

- Fix user-defined fields appearing as user:field_xxx in templates
  * Custom fields now use actual property names from settings
  * Also fixed totalTrackedTime to map to timeEntries property
  * Ensures Bases can properly query user-defined fields

- Fix documentation quote escaping in YAML examples
  * Use single quotes for strings containing double quotes
  * Makes examples copyable and syntactically correct

- Remove internal Bases filtering guide
  * Direct users to official Obsidian Bases documentation
  * Eliminates duplicate documentation of Obsidian functionality
2025-11-19 21:25:40 +11:00
callumalpass
96e01ae58b docs: add i18n-state-manager documentation and clean up development section 2025-11-04 14:02:24 +11:00
callumalpass
b570e1124e docs: add privacy policy to documentation
- Add privacy.md to docs directory
- Add Privacy Policy to navigation in mkdocs.yml
2025-11-02 16:39:58 +11:00
callumalpass
326020a678 docs: configure custom domain tasknotes.dev
- Update site_url in mkdocs.yml to use tasknotes.dev
- Add CNAME file for GitHub Pages custom domain configuration
2025-11-02 16:34:36 +11:00
callumalpass
5bbcc6443e docs: improve home page, features, and core concepts with natural tone
- Remove formatting (bold-label lists) throughout
- Rewrite content with natural, human-written prose
- Standardize reference links to consistent "See [link] for details"
format
- Add comprehensive API and advanced documentation to MkDocs navigation
- Maintain technical accuracy while improving readability and
professionalism
2025-09-14 11:42:35 +10:00
Callum Alpass
3c6e2ac215 docs: Add comprehensive release notes documentation
- Add all GitHub release notes as individual markdown files in docs/releases/
- Create releases index page with organized version listings
- Integrate release notes into MkDocs navigation
- Add script to automatically generate release notes from GitHub releases
2025-07-20 08:27:31 +10:00
Callum Alpass
4aa07da4a9 Update docs (#107) 2025-06-30 21:58:35 +10:00
Callum Alpass
78cb270f89 docs: Restructure and streamline documentation for improved clarity
• Removed outdated/redundant docs files:
 – Deleted "docs/concepts-rationale.md" and "docs/creating-editing-tasks.md" which duplicated content now integrated into core-concepts and task management documentation.
 – Removed "docs/features/natural-language.md" and "docs/features/time-tracking.md" as their content has been merged or rephrased in other feature docs.
 – Deleted the legacy "docs/views/task-view.md" to avoid overlap with the new Task List View documentation.

• Revised core concept and feature documents:
 – Updated "docs/core-concepts.md" to better explain the “note-per-task” approach and YAML frontmatter benefits.
 – Streamlined "docs/features.md" and its subpages (Inline Task Integration, Calendar Integration, and the new Time Management doc) to reflect a unified, concise explanation of TaskNotes’ feature set.
 – Refined inline task, calendar, and settings docs (including advanced, inline task, and task defaults) for consistent language and structure.

• Introduced new documentation:
 – Added "docs/features/time-management.md" to clearly outline time tracking, Pomodoro timer, and productivity analytics.
 – Created "docs/views/task-list.md" to complement the suite of views now including Agenda, Kanban, Notes, Calendar, and Pomodoro views.

• General improvements:
 – Reworded and reorganized sections across multiple docs to enhance readability and better align with the new design philosophy.
 – Consolidated similar topics and removed duplicate descriptions to simplify the overall documentation structure.
 
These changes improve the organization, clarity, and maintainability of the TaskNotes documentation, making it easier for users to understand the core concepts and features.
2025-06-29 13:14:07 +10:00
Callum Alpass
ae59072a17 update docs 2025-06-29 12:53:12 +10:00
Callum Alpass
99ce83f897 Initial documentation 2025-06-29 12:26:57 +10:00