Refactor: Skills documentation for progressive disclosure#30
Closed
philoserf wants to merge 4 commits into
Closed
Conversation
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
Author
|
Feel free to reject this without remorse. NOTE: I used four commits to aid in review. |
Author
|
I see I missed #5 |
Author
|
Outdated. Closing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Implementation:
Changes
json-canvas
colors.md- Color specifications and hex valuesedges.md- Canvas edge types and propertiesnode-types.md- Node type definitions and configurationsvalidation.md- JSON schema validation detailsexamples.md- Usage examples and patternsobsidian-bases
filters.md- Database filtering syntax and operatorsformulas.md- Formula reference and operatorsfunctions-reference.md- Function documentationviews.md- View types and configuration optionsexamples.md- Usage examplesobsidian-markdown
callouts.md- Callout syntax and styling optionswikilinks.md- Wikilink reference and advanced featuresembeds.md- Embed syntax and configurationadvanced.md- Advanced markdown featuresproperties-tags.md- Frontmatter properties and tagsexamples.md- Usage examplesConfiguration
.markdownlint.jsonfor consistent markdown linting standardsTotal Impact