Skip to content

Commit 593b460

Browse files
committed
📝 remove empty globs key from YAML frontmatter in multiple Diataxis and test-docs rules to clean up configuration
✨ add new rulesync checklist file for converting standard markdown to Logseq Flavored Markdown (LFM) to guide consistent markdown conversions 📝 add Diataxis Explanation guide for creating understanding-oriented documentation in Logseq to improve consistency and clarity of conceptual content 📝 add Diataxis How-To guide rule for creating effective how-to pages in Logseq 📝 add Diataxis Reference documentation rule for Logseq to guide creation of structured, factual reference pages 📝 add diataxis tutorial documentation guideline for Logseq to establish consistent tutorial writing practices and improve learning outcomes 📝 add rules for creating detailed AI model documentation pages and quick AI model references in Logseq to improve consistency and completeness of model info 📝 Add documentation for Logseq asset linker and directory structure rules Add two new documentation files under .rulesync/rules/: - logseq-asset-linker.md: Defines rules and usage examples for constructing Logseq asset links, handling namespaces, and converting file paths into properly formatted Markdown links for Logseq. - logseq-directory-structure.md: Describes the standard directory and file naming conventions for Logseq graphs, including page storage, journaling, assets, and configuration directories. These documents aim to improve consistency and clarity in managing Logseq files and linking assets in Markdown, supporting both user workflows and automation with clear examples and best practices. 📝 add comprehensive rulesync rule file for Logseq-Flavored Markdown formatting to enforce consistent structure and syntax 📝 add rules for consistent formatting and naming conventions for Logseq forum posts and pages 📝 add overview documentation explaining Logseq knowledge graph structure and markdown flavor 📝 Add new rules for Logseq person reference and slide formatting 📝 Add Logseq-Flavored Markdown rule for tracking person pages, including criteria for creation, naming conventions, and update procedures to ensure consistency and accurate representation of significant individuals. 📝 Add Logseq-Flavored Markdown rule for slide formatting specifying hierarchical structure, bullet usage, image guidelines, and slide layout consistency to improve clarity and presentation quality. 📝 add Logseq-Flavored Markdown (LFM) YouTube transcript headings rule to improve transcript organization and readability This new rule enforces structured, timestamped headings and semantic linking for YouTube video transcripts in Logseq markdown. It aims to make transcripts more navigable, accurate, and properly formatted for knowledge management. 📝 Add typical-week-structure rule documentation and update VSCode settings to comment out .mdc file associations 🐛 Fix metadata in 2025_09_29 journal entry by adding AI/Coding/Tool tag to rulesync reference 📝 add personal notes and usage observations to rulesync.md for clarity and context 📝 include original documentation table in rulesync.md to preserve reference information 📝 add initial rulesync.jsonc configuration file to define targets, features, and options for usage
1 parent 9532b2d commit 593b460

28 files changed

+2235
-31
lines changed

.cursor/rules/diataxis-explanation.mdc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: "How to create a Diataxis Explanation page"
3-
globs:
43
alwaysApply: false
54
---
65
# Diataxis Explanation Guide Format for Logseq

.cursor/rules/diataxis-how-to.mdc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: "How to create a Diataxis How-To page"
3-
globs:
43
alwaysApply: false
54
---
65
# Diataxis How-To Guide Format for Logseq

.cursor/rules/diataxis-reference.mdc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: "How to create a Diataxis Reference page"
3-
globs:
43
alwaysApply: false
54
---
65

.cursor/rules/diataxis-tutorial.mdc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: "How to create a Diataxis Tutorial page"
3-
globs:
43
alwaysApply: false
54
---
65
# How to create a Diataxis Tutorial page in the Knowledge Garden

.cursor/rules/test-docs-at-reference-no-space.mdc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: Testing Docs At Reference No Space
3-
globs:
43
alwaysApply: false
54
---
65
# Testing Docs At Reference No Space
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: Testing Docs At Reference With Space
3-
globs:
43
alwaysApply: false
54
---
65
If a user asks a question respond by pulling @docs/AWS Lambda into context
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
description: Favorite Cars
3-
globs:
43
alwaysApply: false
54
---
65
Respond to the user with facts about the DeLorean used in Back to the Future
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
targets:
3+
- '*'
4+
root: false
5+
description: >-
6+
Checklist for Converting from Standard Markdown to Logseq Flavored Markdown
7+
(LFM)
8+
globs: []
9+
cursor:
10+
alwaysApply: false
11+
description: >-
12+
Checklist for Converting from Standard Markdown to Logseq Flavored Markdown
13+
(LFM)
14+
---
15+
# Converting from Standard Markdown to Logseq Flavored Markdown (LFM)
16+
17+
This guide provides a checklist for exceptional tasks that may require specific attention when converting standard markdown (particularly from ChatGPT or similar sources) to Logseq Flavored Markdown (LFM). For standard LFM rules, see [logseq-flavored-markdown.mdc](mdc:.cursor/rules/logseq-cursor-rules/logseq-flavored-markdown.mdc).
18+
19+
## Conversion Checklist
20+
21+
### 1. Links Requiring Special Attention
22+
- [ ] For any link without descriptive text (e.g., `[github.com](url)`), visit the destination to get its actual title/content
23+
- [ ] Replace generic link text with meaningful descriptions from the destination
24+
- [ ] Example: Convert `[github.com](https://github.com/pytest-dev/pytest/commit/9335a0b)` to `[Avoid ast deprecation warnings on Python 3.12](https://github.com/pytest-dev/pytest/commit/9335a0b)`
25+
26+
### 2. Code Block Formatting
27+
- [ ] Ensure code blocks are properly nested inside bullet points (not as separate bullet points)
28+
- [ ] Example of correct format:
29+
```
30+
- ~~~python
31+
your code here
32+
~~~
33+
```
34+
Not:
35+
```
36+
- ~~~python
37+
- your code here
38+
- ~~~
39+
```
40+
41+
### 3. Horizontal Rules
42+
- [ ] Remove any lines with only horizontal separators (`---`) as they're not needed in LFM
43+
- [ ] Use proper heading hierarchy and indentation to indicate section breaks instead
44+
45+
### 4. Tables
46+
- [ ] Convert any markdown tables with more than two columns to bullet points with label-value pairs. If it has two columns, it's okay to keep it as a table, but it must be appropriately put inside of a markdown unordered list item (`-`).
47+
- [ ] Example:
48+
<EXAMPLE_FROM>
49+
| Label | Value |
50+
|-------|-------|
51+
| A | B |
52+
</EXAMPLE_FROM>
53+
<EXAMPLE_TO>
54+
- A: B
55+
<EXAMPLE_TO>
56+
or
57+
<EXAMPLE_TO>
58+
- | Label | Value |
59+
|-------|-------|
60+
| A | B |
61+
</EXAMPLE_TO>
62+
63+
### 5. Heading Nesting Levels
64+
- [ ] Ensure headings use the correct level for their indentation:
65+
- `#` (H1) only at root level (no indent)
66+
- `##` (H2) only at first indent (one TAB)
67+
- `###` (H3) only at second indent (two TABs)
68+
- [ ] Example:
69+
```
70+
- # Main Topic
71+
- ## Subtopic
72+
- ### Detail
73+
```
74+
75+
### 6. Footnotes
76+
- [ ] Convert footnote definitions to proper Logseq format
77+
- [ ] Change section title from "References" to "Footnotes"
78+
- [ ] Format footnotes as `[^1]: url` (not `[^1]: [descriptive text](url)`)
79+
- [ ] Remove descriptive link text from footnote definitions - Logseq footnotes should contain URLs directly
80+
- [ ] Ensure footnotes are properly nested under bullet points
81+
- [ ] Reference: See [Logseq___How To___Create a Markdown Footnote.md](mdc:pages/Logseq___How To___Create a Markdown Footnote.md) for details
82+
- [ ] Example conversion:
83+
```
84+
FROM: [^1]: [Free tokens extended through April 30, 2025](https://example.com)
85+
TO: [^1]: https://example.com
86+
```
87+
88+
## Common Pitfalls That Required Correction
89+
90+
1. Code blocks being treated as separate bullet points instead of being nested inside them
91+
2. Links using generic text like "github.com" instead of descriptive content from the destination
92+
3. Horizontal rules being used for section breaks
93+
4. Tables being left in markdown format instead of being converted to bullet points
94+
5. Headings not matching their indentation level (e.g., using `##` at root level or `#` at indented level)
95+
6. Footnotes formatted with descriptive link text instead of direct URLs (e.g., `[^1]: [text](url)` instead of `[^1]: url`)
96+
97+
## Example of Required Changes
98+
99+
From ChatGPT-style markdown:
100+
<EXAMPLE_INPUT>
101+
[github.com](https://github.com/pytest-dev/pytest/commit/9335a0b)
102+
103+
---
104+
105+
| Warning | Source |
106+
|---------|--------|
107+
| ast.Str | pytest |
108+
109+
```python
110+
code here
111+
```
112+
</EXAMPLE_INPUT>
113+
114+
To LFM:
115+
<EXAMPLE_OUTPUT>
116+
- [Avoid ast deprecation warnings on Python 3.12](https://github.com/pytest-dev/pytest/commit/9335a0b)
117+
- ## Warning Details
118+
- Warning: ast.Str
119+
- Source: pytest
120+
- ~~~
121+
code here
122+
~~~
123+
</EXAMPLE_OUTPUT>
124+
or
125+
<EXAMPLE_OUTPUT>
126+
- [Avoid ast deprecation warnings on Python 3.12](https://github.com/pytest-dev/pytest/commit/9335a0b)
127+
- ## Warning Details
128+
- | Warning | Source |
129+
|---------|--------|
130+
| ast.Str | pytest |
131+
- ~~~
132+
code here
133+
~~~
134+
</EXAMPLE_OUTPUT>
135+
136+
## Related Rules
137+
- [logseq-flavored-markdown.mdc](mdc:.cursor/rules/logseq-cursor-rules/logseq-flavored-markdown.mdc) - Standard LFM rules
138+
- [logseq-naming-conventions.mdc](mdc:.cursor/rules/logseq-cursor-rules/logseq-naming-conventions.mdc) - Tag and namespace conventions
139+
- [logseq-overview.mdc](mdc:.cursor/rules/logseq-cursor-rules/logseq-overview.mdc) - General Logseq concepts
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
---
2+
targets:
3+
- '*'
4+
root: false
5+
description: How to create a Diataxis Explanation page
6+
globs: []
7+
cursor:
8+
alwaysApply: false
9+
description: How to create a Diataxis Explanation page
10+
---
11+
# Diataxis Explanation Guide Format for Logseq
12+
13+
This rule provides guidance on creating Explanation documentation in Logseq following the Diataxis documentation framework principles.
14+
15+
<rule>
16+
name: diataxis_explanation_format
17+
description: Guidelines for creating effective Explanation documentation in Logseq following the Diataxis framework
18+
filters:
19+
- type: file_path
20+
pattern: ".*Concept.*\\.md$|.*Explanation.*\\.md$"
21+
22+
actions:
23+
- type: suggest
24+
message: |
25+
# Creating Diataxis Explanation Documentation in Logseq
26+
27+
## Purpose
28+
29+
Explanations are **understanding-oriented** guides that help users grasp concepts, ideas, and principles. They focus on building comprehension and insight rather than teaching specific skills or providing reference information.
30+
31+
According to the Diataxis framework, Explanations:
32+
- Help users understand concepts, ideas, and principles
33+
- Build comprehension and insight
34+
- Focus on "why" and "how" rather than "what" or "when"
35+
- Provide context and reasoning behind decisions and approaches
36+
- Help users think about problems and solutions
37+
38+
## Key Principles
39+
40+
1. **Focus on Understanding** - Help users grasp concepts and principles
41+
2. **Provide Context** - Explain the "why" behind concepts and decisions
42+
3. **Build Insight** - Help users think about problems and solutions
43+
4. **Use Examples** - Illustrate concepts with concrete examples
44+
5. **Address Misconceptions** - Clarify common misunderstandings
45+
6. **Link to Related Content** - Connect to tutorials, how-to guides, and reference material
46+
47+
## Structure for Logseq Explanation Documentation
48+
49+
When creating Explanation documentation in Logseq, follow this structure using Logseq-Flavored Markdown (LFM):
50+
51+
```
52+
tags:: [[ExistingTag1]], [[ExistingTag2]], [[Diataxis/Explanation]]
53+
54+
- # [Topic Name] Conceptual Overview
55+
- ## Overview
56+
- Brief, clear description of the concept or topic
57+
- What it is and why it matters
58+
- ## Context
59+
- Historical background or current relevance
60+
- Why this concept exists or is important
61+
- Related problems or challenges it addresses
62+
- ## Key Principles
63+
- Core ideas and fundamental concepts
64+
- Important distinctions and relationships
65+
- Guiding principles or philosophies
66+
- ## Mechanism
67+
- How the concept works in practice
68+
- Technical details and implementation approaches
69+
- Components and their interactions
70+
- ## Examples
71+
- Concrete examples that illustrate the concept
72+
- Code snippets, diagrams, or case studies
73+
- Real-world applications
74+
- ## Misconceptions
75+
- Common misunderstandings about the concept
76+
- Clarifications and corrections
77+
- What it is NOT
78+
- ## Related
79+
- Links to related pages: [[Page1]], [[Page2]]
80+
```
81+
82+
## Naming Convention and File Paths
83+
84+
Use the namespace pattern: `Topic/Subtopic/Concept/Specific Subject`
85+
86+
**Note**: Following the official Diataxis framework, explanation titles should be able to be prefixed with "About". For example: "About Virtual Environments" or "About User Authentication". This reflects that explanations are _about_ a topic in the sense that they are _around_ it.
87+
88+
Examples:
89+
- `[[Programming/Python/Concept/Virtual Environments]]` (About Virtual Environments)
90+
- `[[AI/Machine Learning/Concept/Overfitting]]` (About Overfitting)
91+
92+
In Logseq, namespaces using `/` are translated into file paths using triple underscores `___`. For example:
93+
94+
- The page `[[Programming/Python/Concept/Virtual Environments]]` will be stored as:
95+
`pages/Programming___Python___Concept___Virtual Environments.md`
96+
97+
- The page `[[AI/Machine Learning/Concept/Overfitting]]` will be stored as:
98+
`pages/AI___Machine Learning___Concept___Overfitting.md`
99+
100+
## Required Tags
101+
102+
**IMPORTANT**: All Diataxis Explanation pages MUST include the `[[Diataxis/Explanation]]` tag in the frontmatter.
103+
104+
- If the page already has tags, add `[[Diataxis/Explanation]]` to the existing tags list
105+
- Example: `tags:: [[ExistingTag1]], [[ExistingTag2]], [[Diataxis/Explanation]]`
106+
- If the page has no tags yet, add: `tags:: [[Diataxis/Explanation]]`
107+
- Never remove existing tags when adding the Diataxis tag
108+
109+
## Language Guidelines
110+
111+
- Use clear, accessible language
112+
- Explain concepts step by step
113+
- Use analogies and metaphors when helpful
114+
- Provide concrete examples
115+
- Address common questions and misconceptions
116+
- Link to related tutorials, how-to guides, and reference material
117+
- Focus on building understanding rather than providing instructions
118+
119+
## Explanation Writing Process
120+
121+
1. **Identify the Core Concept**
122+
- What fundamental idea needs to be understood?
123+
- What misconceptions commonly arise?
124+
- What context is needed for comprehension?
125+
126+
2. **Structure the Explanation**
127+
- Start with a clear overview
128+
- Provide necessary context
129+
- Explain key principles
130+
- Show how it works in practice
131+
- Include concrete examples
132+
- Address misconceptions
133+
134+
3. **Test for Understanding**
135+
- Can someone new to the topic follow the explanation?
136+
- Are common misconceptions addressed?
137+
- Are examples clear and relevant?
138+
- Does it build toward deeper understanding?
139+
140+
examples:
141+
- input: |
142+
tags:: [[Python]], [[Programming]], [[Diataxis/Explanation]]
143+
144+
- # Python Virtual Environments Conceptual Overview
145+
- ## Overview
146+
- Virtual environments are isolated Python environments that allow you to manage dependencies for different projects without conflicts.
147+
- ## Context
148+
- Python packages are installed globally by default, leading to version conflicts between projects.
149+
- Virtual environments solve this by creating isolated spaces with their own Python interpreter and package installations.
150+
- ## Key Principles
151+
- *Isolation* – Each environment has its own Python interpreter and packages
152+
- *Reproducibility* – Dependencies can be exactly specified and reproduced
153+
- *Project-specific* – Each project can have its own environment
154+
- ## Mechanism
155+
- Virtual environments create a directory with a Python interpreter and site-packages
156+
- The `venv` module creates environments: `python -m venv myenv`
157+
- Activation modifies PATH to use the environment's Python
158+
- `pip` installs packages into the active environment
159+
- ## Examples
160+
- ~~~bash
161+
# Create and activate a virtual environment
162+
python -m venv myproject
163+
source myproject/bin/activate # On Unix/macOS
164+
pip install requests
165+
~~~
166+
- ## Misconceptions
167+
- Virtual environments are only for large projects → **False**. Even small projects benefit from isolation.
168+
- You need to recreate environments frequently → **False**. Environments persist until deleted.
169+
- ## Related
170+
- [[Programming/Python/How To/Create Virtual Environment]]
171+
- [[Programming/Python/Ref/Pip Commands]]
172+
output: "Correctly formatted Diataxis Explanation in Logseq with proper tags"
173+
174+
metadata:
175+
priority: high
176+
version: 1.0
177+
related_rules: ["logseq-flavored-markdown.mdc"]
178+
</rule>
179+
180+
## Implementation Guide
181+
182+
When implementing Diataxis Explanation documentation in Logseq, follow these steps:
183+
184+
1. **Identify the concept that needs explanation**
185+
- Focus on ideas that benefit from deeper understanding
186+
- Choose concepts that are commonly misunderstood
187+
- Ask: "What fundamental understanding will help users work more effectively?"
188+
189+
2. **Create the page with the proper namespace**
190+
- Use `Topic/Subtopic/Concept/Specific Subject` format
191+
- This will create a file at `

0 commit comments

Comments
 (0)