|
|
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 |
|
|
|
908f2c1c93
|
doc(concepts): building blocks of platforms recommended by John Dietz, CEO of Konstruct
|
2025-01-23 15:44:55 +01:00 |
|
|
|
311269eb39
|
Merge branch 'development'
|
2024-12-19 10:04:45 +01:00 |
|
|
|
7ab69e9139
|
fix(): typo
|
2024-12-11 15:05:15 +01:00 |
|
|
|
8599ddbefc
|
Telemetry Use Case
added Telemetry Use Case showing Fibonacci workload
|
2024-12-05 14:27:02 +01:00 |
|
kai.reichart
|
805bb5de09
|
Merge branch 'main' into feature/cicd-concept
|
2024-11-11 12:46:57 +00:00 |
|
|
|
cd03301ee8
|
Added articles about backstage templates included into idpbuilder ref-implementation
|
2024-10-29 08:01:53 +01:00 |
|
|
|
08847aac0a
|
fix()
|
2024-10-17 07:46:36 +00:00 |
|
|
|
529fa5423a
|
Merge branch 'main' into development
|
2024-10-11 11:51:19 +02:00 |
|
|
|
952d170d83
|
refactor(solution): section 'solution' refactored into a dedicated 'CNOE' subsection
|
2024-10-11 09:34:06 +00:00 |
|
|
|
8dcf100525
|
feat(use-cases): added socksshop fork from mkdev - looks interesting
|
2024-10-10 14:16:30 +02:00 |
|
|
|
984c16d3a7
|
fix(doc): removed platfrom typo
|
2024-10-10 13:18:15 +02:00 |
|
|
|
6419ffd6ec
|
refactor(documentation-structure): section concepts/platforms refactored to the general documentation layout with descriptions
|
2024-10-10 07:50:55 +00:00 |
|
Florian Fürstenberg
|
5e3c0e459a
|
feat(cicd): two additional components added for the release category
|
2024-10-08 15:47:01 +02:00 |
|
Florian Fürstenberg
|
d236e059cd
|
feat(cicd): initial commit for the general concept
|
2024-10-08 14:58:02 +02:00 |
|
|
|
4ed21ee54d
|
refactor(ipceicis-460-cnoe-deep-dive): top level documenation hierarchy refoctored to three entries concepts, solurion, project
|
2024-09-29 12:20:35 +02:00 |
|
