Skip to content

Commit 400338b

Browse files
committed
Replace .markdownlint.json with .markdownlint.jsonc and update rules, update README.md, Add TASKS.md
- Remove old markdownlint configuration file - Add new .markdownlint.jsonc with updated linting rules - Update README to reflect project management changes and add new sections - Create TASKS.md for task tracking and project management
1 parent 6c1d348 commit 400338b

File tree

4 files changed

+146
-38
lines changed

4 files changed

+146
-38
lines changed

.markdownlint.json

Lines changed: 0 additions & 30 deletions
This file was deleted.

.markdownlint.jsonc

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// Lint rule copied from https://github.com/pstackebrandt/BlazorCookbookApp/blob/23e87a984df548e90fdebaa429946cc9638dae49/.markdownlint.jsonc
2+
{
3+
"default": true,
4+
"MD013": {
5+
"line_length": 120,
6+
"code_blocks": false,
7+
"tables": false
8+
},
9+
"MD024": {
10+
"siblings_only": true
11+
},
12+
"MD025": {
13+
"front_matter_title": "title"
14+
},
15+
"MD033": false,
16+
"MD041": false,
17+
"MD022": false,
18+
"MD026": {
19+
"punctuation": ".,;:!?"
20+
},
21+
"MD029": {
22+
"style": "ordered"
23+
},
24+
"MD030": {
25+
"ul_single": 1,
26+
"ol_single": 1
27+
},
28+
"MD031": false,
29+
"MD032": false,
30+
"MD034": false,
31+
"MD035": {
32+
"style": "---"
33+
},
34+
"MD036": false,
35+
"MD037": false,
36+
"MD038": false,
37+
"MD039": false,
38+
"MD040": false,
39+
"MD042": false,
40+
"MD043": false,
41+
"MD044": {
42+
"names": ["Obsidian", "Markdown", "GitHub", "pstackebrandt.github.io", "github"]
43+
},
44+
"MD045": false,
45+
"MD046": {
46+
"style": "fenced"
47+
},
48+
"MD047": false,
49+
"MD048": {
50+
"style": "backtick"
51+
},
52+
"MD049": {
53+
"style": "asterisk"
54+
},
55+
"MD050": {
56+
"style": "asterisk"
57+
},
58+
"MD051": false,
59+
"MD052": false,
60+
"MD053": false
61+
}

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
- [Project management](#project-management)
1515
- [Documentation](#documentation)
1616
- [Cursor IDE Configuration](#cursor-ide-configuration)
17+
- [.cursorignore](#cursorignore)
18+
- [.cursorindexingignore](#cursorindexingignore)
19+
- [How to Use](#how-to-use)
1720
- [History](#history)
1821
- [Publishing](#publishing)
1922

@@ -54,7 +57,7 @@ Those will update the version number in the `package.json` file and trigger rela
5457

5558
## Deploy app
5659

57-
Run deploy script (incl. build) and publish to github pages
60+
Run deploy script (incl. build) and publish to GitHub Pages
5861

5962
```powershell
6063
npm run deploy
@@ -78,10 +81,11 @@ See the section about [deployment](https://facebook.github.io/create-react-app/d
7881

7982
## Project management
8083

81-
I use github for project management.
84+
I am currently using the `TASKS.md` file in the root of this project to track tasks.
8285

83-
- I use the issues section to track tasks.
84-
- I use the projects section to track the board.
86+
Previously, I used GitHub for project management.
87+
The [GitHub Issues](https://github.com/pstackebrandt/pstackebrandt.github.io/issues) and the [GitHub Project](https://github.com/users/pstackebrandt/projects/3)
88+
are still available but are not actively used for now.
8589

8690
## Documentation
8791

@@ -93,7 +97,8 @@ This project includes configuration files for Cursor IDE to improve performance
9397

9498
### .cursorignore
9599

96-
The `.cursorignore` file tells Cursor which files and directories to exclude from various operations like search, indexing, and AI context. Similar to `.gitignore`, it uses pattern matching.
100+
The `.cursorignore` file tells Cursor which files and directories to exclude from various operations like search, indexing,
101+
and AI context. Similar to `.gitignore`, it uses pattern matching.
97102

98103
**Key exclusions:**
99104
- Dependencies and node_modules
@@ -105,11 +110,10 @@ The `.cursorignore` file tells Cursor which files and directories to exclude fro
105110

106111
### .cursorindexingignore
107112

108-
The `.cursorindexingignore` file specifically controls what's excluded from Cursor's code indexing functionality.
113+
The `.cursorindexingignore` file specifically controls what's excluded from Cursor's code indexing functionality.
109114
This helps improve performance by reducing the indexed codebase size.
110115

111116
**Key exclusions:**
112-
113117
- Build output and generated files
114118
- Large data files (with exceptions for config files)
115119
- Test fixtures and documentation files
@@ -135,4 +139,4 @@ The app runs now directly in the root folder, not in a subfolder like its predec
135139

136140
### Publishing
137141

138-
- The app is now published with github pages.
142+
- The app is now published with GitHub Pages.

TASKS.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Homepage Project Tasks
2+
3+
---
4+
5+
## Next Actions
6+
7+
*Waiting for initial tasks to be defined.*
8+
9+
---
10+
11+
## Todo
12+
13+
### Epic: Core Features
14+
15+
- [ ] **P1** T1 [M] Set up basic project structure (e.g., React, Webpack, Babel).
16+
- [ ] **P2** T2 [L] Design and implement the main layout and navigation.
17+
18+
### Epic: Content
19+
20+
- [ ] **P3** T3 [S] Write and add content for the home page.
21+
22+
---
23+
24+
## In Progress
25+
26+
(No tasks currently in progress)
27+
28+
---
29+
30+
## Deferred
31+
32+
- [ ] ⏸️ T4 [S] Add a blog section. [DEFERRED] Post-launch feature.
33+
34+
---
35+
36+
## Backlog
37+
38+
### Epic: Nice-to-Have Features
39+
40+
- [ ] **P4** T5 [M] Implement dark mode.
41+
- [ ] **P4** T6 [S] Add animations to page transitions.
42+
43+
---
44+
45+
## Done
46+
47+
- [x] ✅ T9 [S] Fix MD044 linting and update README formatting.
48+
- [x] ✅ T8 [S] Update .markdownlint.json configuration.
49+
- [x] ✅ T7 [S] Update README.md to mention TASKS.md for project management.
50+
- [x] ✅ T0 [S] Initialized project repository.
51+
52+
---
53+
54+
## Notes
55+
56+
- Use `- [ ]` for incomplete tasks.
57+
- Use `- [x] ✅` for completed tasks.
58+
- Use `- [x] ⏸️` for deferred tasks.
59+
- **Task Order**: In the Done section, newer tasks are at the top.
60+
- **Priorities**: P1 (Highest) to P4 (Lowest). P5 tasks are not planned.
61+
- **Task Format**: Use `[ ] **Priority** TaskID [Size] Description [Depends on TX, TY]`.
62+
- **Linking**: For tasks related to specific files, consider adding a markdown link to the file for quick navigation.
63+
64+
---
65+
66+
## Examples
67+
68+
### Epic: Example Epic
69+
70+
- [ ] **P1** T1 [S] Short description of a high-priority task.
71+
- [ ] **P3** T2 [M] Short description of a medium-priority task. [Depends on T1]
72+
- [ ] T2.1 Short description of subtask.
73+
- [x] ✅ T3 [S] Example of a completed task.

0 commit comments

Comments
 (0)