|
|
a4d717bdd2
|
chore()
|
2025-11-12 00:33:03 +01:00 |
|
|
|
f797af114b
|
test: configure comprehensive markdown linting with Docsy best practices
Configure markdownlint with rules aligned to technical documentation
standards and Docsy theme conventions.
Design Decisions:
- Enable core quality rules (heading hierarchy, consistent list styles)
- Allow inline HTML for Docsy shortcodes and components
- Permit bare URLs (common in technical documentation)
- Make code block language hints optional (pragmatic for existing content)
- Set maximum 2 consecutive blank lines (balanced readability)
- Enforce single trailing newline (POSIX standard)
- Use asterisk for unordered lists (consistency)
- Allow 2-space list indentation (Markdown standard)
Auto-fixed Issues:
- Converted dash lists to asterisk lists (568 fixes)
- Removed trailing spaces (211 fixes)
- Added missing trailing newlines (74 fixes)
- Added blank lines around lists and headings (100+ fixes)
Remaining Style Warnings (intentionally accepted):
- MD029: List numbering variations in meeting notes (75 instances)
- MD036: Bold text for section headers in ADRs (13 instances)
- MD025: Multiple H1 in notes/brainstorming docs (10 instances)
- MD032/MD022: Minor spacing variations (15 instances)
Test Results:
✅ Hugo build: 227 pages generated successfully
✅ HTML validation: No errors
✅ Link checking: All links valid (except dev-only livereload)
✅ Markdown linting: Only non-critical style warnings remain
The configuration balances strict quality checks with pragmatic
flexibility for diverse content types (documentation, ADRs, meeting
notes, tutorials).
|
2025-10-23 14:25:46 +02:00 |
|
Bot
|
1bbedec64a
|
ex post: review minutes 01.04.25
|
2025-04-29 15:21:31 +02:00 |
|
|
|
08847aac0a
|
fix()
|
2024-10-17 07:46:36 +00:00 |
|
|
|
39f2d15019
|
doc(project): blog refactored
|
2024-08-24 13:54:42 +00:00 |
|
|
|
6fbcc5e8a0
|
refactor(project): folders for streams and activities
|
2024-08-23 14:53:32 +00:00 |
|
|
|
456de17918
|
Merge remote-tracking branch 'refs/remotes/origin/development' into development
|
2024-08-23 15:45:51 +02:00 |
|
|
|
6d5b6bceec
|
doc(platform-blog): added some more links for architectural session blog
|
2024-08-23 14:09:26 +02:00 |
|
|
|
82d775cec5
|
doc(platform-blog): added some more links for architectural session blog
|
2024-08-23 14:01:56 +02:00 |
|
|
|
fe48e8b66c
|
doc(blog-architecture): WiP - some links about platform generics
|
2024-08-23 12:30:21 +02:00 |
|
|
|
694eea4095
|
chore(hugo-theme): moved to docsy. Started from https://github.com/google/docsy-example and ported all ipceicis content to there. removed all docsy example stuff
|
2024-08-05 11:56:38 +02:00 |
|