Skip to content

Refactor: Skills documentation for progressive disclosure#30

Closed
philoserf wants to merge 4 commits into
kepano:mainfrom
x3c3:refactor/skills-for-progressive-disclosure
Closed

Refactor: Skills documentation for progressive disclosure#30
philoserf wants to merge 4 commits into
kepano:mainfrom
x3c3:refactor/skills-for-progressive-disclosure

Conversation

@philoserf
Copy link
Copy Markdown

Overview

This PR is provided for consideration and implements progressive disclosure across three Obsidian skills: json-canvas, obsidian-bases, and obsidian-markdown.

What is Progressive Disclosure?

Progressive disclosure is a UX pattern where detailed information is organized hierarchically, presenting essential concepts first while relegating reference material to secondary documents. This approach offers several advantages:

Benefits:

  • Reduced cognitive load - Users encounter core concepts without being overwhelmed by reference details
  • Better onboarding - New users can learn the fundamentals from SKILL.md before exploring advanced topics
  • Improved navigation - Readers can find specific reference material more easily in focused documents
  • Clearer documentation hierarchy - SKILL.md serves as the authoritative introduction; supplementary files provide depth

Implementation:

  • SKILL.md files remain as comprehensive skill overviews and entry points
  • Detailed reference content is extracted into focused, single-purpose documents
  • Clear cross-references maintain discoverability

Changes

json-canvas

  • Extracted colors.md - Color specifications and hex values
  • Extracted edges.md - Canvas edge types and properties
  • Extracted node-types.md - Node type definitions and configurations
  • Extracted validation.md - JSON schema validation details
  • Extracted examples.md - Usage examples and patterns
  • Condensed SKILL.md from 1,226 lines to 654 lines

obsidian-bases

  • Extracted filters.md - Database filtering syntax and operators
  • Extracted formulas.md - Formula reference and operators
  • Extracted functions-reference.md - Function documentation
  • Extracted views.md - View types and configuration options
  • Extracted examples.md - Usage examples
  • Condensed SKILL.md from 1,120 lines to 518 lines

obsidian-markdown

  • Extracted callouts.md - Callout syntax and styling options
  • Extracted wikilinks.md - Wikilink reference and advanced features
  • Extracted embeds.md - Embed syntax and configuration
  • Extracted advanced.md - Advanced markdown features
  • Extracted properties-tags.md - Frontmatter properties and tags
  • Extracted examples.md - Usage examples
  • Condensed SKILL.md from 1,076 lines to 599 lines

Configuration

  • Added .markdownlint.json for consistent markdown linting standards

Total Impact

  • Reduced core SKILL.md files by ~1,280 lines (55% reduction)
  • Created 18 new focused reference documents
  • Improved documentation structure for progressive disclosure

Split monolithic SKILL.md into modular reference files for better
navigation and progressive disclosure. Core skill overview remains in
SKILL.md while detailed reference material is in dedicated files:
- colors.md for color specifications
- edges.md for canvas edge types
- node-types.md for node type definitions
- validation.md for schema validation
- examples.md for usage examples
Split monolithic SKILL.md into modular reference files for better
navigation and progressive disclosure. Core skill overview remains in
SKILL.md while detailed reference material is in dedicated files:
- filters.md for database filtering syntax
- formulas.md for formula reference
- functions-reference.md for function documentation
- views.md for view types and configuration
- examples.md for usage examples
Split monolithic SKILL.md into modular reference files for better
navigation and progressive disclosure. Core skill overview remains in
SKILL.md while detailed reference material is in dedicated files:
- callouts.md for callout syntax and styling
- wikilinks.md for wikilink reference
- embeds.md for embed syntax
- advanced.md for advanced markdown features
- properties-tags.md for frontmatter and tags
- examples.md for usage examples
@philoserf
Copy link
Copy Markdown
Author

Feel free to reject this without remorse.

NOTE: I used four commits to aid in review.

@philoserf
Copy link
Copy Markdown
Author

I see I missed #5

@philoserf
Copy link
Copy Markdown
Author

Outdated. Closing.

@philoserf philoserf closed this Jan 27, 2026
@philoserf philoserf deleted the refactor/skills-for-progressive-disclosure branch January 27, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant