Commit graph

27 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
598315dd9e Document materialized occurrences 2026-05-31 21:48:10 +10:00
callumalpass
735706ead4 docs: tighten accuracy, fix cross-links, and consolidate unreleased notes 2026-02-21 13:41: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
1300bd15b0 docs: refresh guides and align links with tasknotes.dev 2026-02-15 11:03:35 +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
d168644661 refactor: split taskPropertiesTab into modular components
- Extract property card renderers into separate modules:
  - helpers.ts: shared types, NLP trigger helpers, simple/metadata cards
  - statusPropertyCard.ts: status values with drag-drop reordering
  - priorityPropertyCard.ts: priority values with drag-drop reordering
  - projectsPropertyCard.ts: projects with autosuggest filters
  - tagsPropertyCard.ts: native Obsidian tags
  - remindersPropertyCard.ts: default reminder configuration
  - titlePropertyCard.ts: title and filename settings
  - userFieldsCard.ts: custom user fields

- Add Feature Properties section for pomodoros, ICS event ID, and
  ICS event tag (properties not stored in task frontmatter)

- Update documentation to reflect settings reorganization:
  - Task Properties tab now contains property keys, defaults, and NLP triggers
  - Defaults tab redirects to new locations
  - Appearance tab references moved settings
  - Features tab documents body template settings
2025-12-02 10:04: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
a3621ca01f Docs: Comprehensive v4.0.0 documentation update
Updates documentation to reflect version 4 changes:
- Bases core plugin integration and requirement
- OAuth calendar integration (Google, Microsoft)
- New Bases-based filtering with YAML expressions
- Removed v3 FilterBar UI references
- Added modal fields settings documentation
- Added 4.0.0 release notes
- Updated all feature guides with v4 functionality
2025-11-18 12:57:46 +11:00
callumalpass
849433fa6a Merge branch 'time-statistics' 2025-09-27 20:05:42 +10:00
Sergen Aras
0bc0c36517 time statistics 2025-09-23 08:58:43 +03:00
renatomen
052b945b49 docs: add comprehensive subgrouping feature documentation
- Document hierarchical subgrouping in filtering-and-views.md with demo GIF
- Add subgrouping section to task-list.md with usage examples
- Update agenda-view.md to reference subgrouping support
- Enhance features.md overview to mention two-level organization
- Include subgroups.gif demonstration of the feature in action

Provides complete documentation for the new hierarchical subgrouping
functionality that allows two-level task organization across views.
2025-09-18 11:16:31 +00: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
callumalpass
4e1312f62b docs: update documentation for version 3.23.1 2025-09-13 21:50:39 +10:00
renatomen
4012ab3b1f docs: update filtering documentation for new modal controls
- Update documentation for new filter modal controls
- Remove jest-out.txt test output file and add to gitignore
- Remove unrelated chrono-node.d.ts file

# Conflicts:
#	docs/features.md
#	docs/features/filtering-and-views.md
2025-08-16 11:24:03 +00:00
Callum Alpass
ac57dd738a feat: add OpenAPI specification and Pomodoro API endpoints
## OpenAPI Specification
- Add decorator-based OpenAPI system with @OpenAPIController and @OpenAPI decorators
- Generate machine-readable OpenAPI 3.0 spec at /api/docs
- Serve interactive Swagger UI documentation at /api/docs/ui
- Complete schema definitions for all API types and responses
- Enable TypeScript experimental decorators support

## Pomodoro API Endpoints
- POST /api/pomodoro/start - Start new pomodoro session with optional task
- POST /api/pomodoro/stop - Stop current session
- POST /api/pomodoro/pause - Pause running session
- POST /api/pomodoro/resume - Resume paused session
- GET /api/pomodoro/status - Get current session status and statistics
- GET /api/pomodoro/sessions - Get session history with filtering
- GET /api/pomodoro/stats - Get daily/date-specific statistics

## Documentation Updates
- Add comprehensive HTTP API documentation with pomodoro examples
- Include JavaScript PomodoroController integration example
- Update feature documentation with view types and settings
- Improve navigation structure across documentation files

## Dependencies
- Add reflect-metadata for decorator metadata support
- Remove unused express dependency
- Update TypeScript configuration for decorator support

All endpoints include proper error handling, OpenAPI documentation, and support for recurring task integration.
2025-08-13 22:12:14 +10:00
Callum Alpass
57fdf0ef00 docs: Document the new notification system 2025-08-07 23:06:06 +10:00
Callum Alpass
c74fe54833 docs: Document custom multi-day calendar view feature (#282)
Add comprehensive documentation for the new configurable custom multi-day
calendar view feature implemented in d27594a:

- Update calendar-views.md with Custom Days view section explaining features
  and configuration steps
- Enhance calendar-settings.md to document default view option and custom
  day count setting
- Update calendar-integration.md to include custom days view in Advanced
  Calendar description
- Update features.md to include custom days view in main features overview

Provides complete user guidance for the custom multi-day calendar view that
allows users to configure any number of days (1-14) in their calendar display.
2025-07-27 12:19:05 +10:00
Callum Alpass
25260920d2 docs: Update filtering and views documentation
- Add comprehensive filtering and views guide
- Update individual view documentation with filter details
- Document advanced filtering features and saved views
- Improve clarity of filter concepts and usage
2025-07-13 08:20:09 +10:00
Callum Alpass
7265628c74 docs: improve README and fix documentation link
- Enhanced README overview section with better flow and natural language
- Added time-tracking and pomodoro feature descriptions to introduction
- Fixed broken link in docs/features.md pointing to correct time-management.md file
- Updated Core Features section with more accurate property list
- Improved rationale section to sound less marketing-oriented
2025-07-11 07:10:26 +10:00
Callum Alpass
3506ce2430 docs: add project subtasks widget documentation
- Add Project Subtasks Widget section to inline-tasks.md
- Update features.md to include widget in inline task integration list
- Add configuration toggle documentation to inline-task-settings.md
- Maintain informational tone consistent with existing documentation
2025-07-10 06:49:52 +10:00
Callum Alpass
83dfc36639 docs: add habit tracking workflow documentation
Added comprehensive habit tracking documentation to new workflows.md page
covering recurring tasks, calendar completion tracking, and organization
strategies. Updated features.md to reference the new workflows section.
2025-07-06 13:28:29 +10:00
Callum Alpass
eca08599d3 refactor documentation 2025-06-29 13:35:47 +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
99ce83f897 Initial documentation 2025-06-29 12:26:57 +10:00