docs: apply KM heading capitalization standards to onpremise README#115
Merged
Conversation
Apply KM Style Guide heading capitalization rules: - H2 sections: Title case (How It Works, Configuration Steps, etc.) - H3+ subsections: Sentence case (Cloud Connector configuration, Deployment prerequisites, etc.) - Update Table of Contents to use dashes (-) instead of asterisks (*) - Fix all anchor links to match updated heading structure Changes: - 13 heading capitalization corrections - Table of Contents format standardized with dash markers - All internal links verified and updated Follows KM documentation standards per docs/km-style-guide.md
🔗 Link Check ResultsThe link checker has completed. This is an optional check and will not block the PR. If broken links were found, please review them at your convenience. Last updated: Run #101 at 2026-03-06T09:01:14Z |
longieirl
added a commit
that referenced
this pull request
Feb 27, 2026
This commit establishes a hybrid documentation review system combining automated linting with AI-powered contextual analysis. ## Changes ### 1. /km-review Skill Created - New skill at .claude/skills/km-review.md - Applies comprehensive KM standards to documentation files - Supports --fix flag for auto-fixes - Supports --score-only for quick quality checks - Supports --ai-only to skip linter (AI review only) - Integrates with docs-linter when available ### 2. docs-linter CLI Implementation - Complete CLI implementation in docs-linter/src/cli.js - Commands: check, fix, validate - Color-coded output with severity levels - JSON output support for programmatic use - Dry-run mode for previewing fixes ### 3. docs-linter Core Updates - Fixed remark processor initialization - Removed unnecessary remarkStringify dependency - Prepared for ESM/CommonJS compatibility ## Architecture The system provides two complementary review approaches: **Fast Automated Review (docs-linter)** - Rule-based checking using AST parsing - Instant feedback on objective violations - Safe auto-fixes for common issues - Pre-commit hook integration ready **Deep Contextual Review (/km-review)** - AI-powered analysis with full context - Understands intent and technical meaning - Explains why issues matter - Catches subjective quality issues ## Usage ### Quick Quality Check /km-review misc/onpremise/README.md --score-only ### Full Review with Findings /km-review misc/onpremise/README.md ### Review and Auto-Fix /km-review misc/onpremise/README.md --fix ### Linter Only (when functional) node docs-linter/src/cli.js validate misc/onpremise/README.md ## Status - ✅ /km-review skill: Fully functional - ✅ docs-linter CLI: Implemented - ✅ docs-linter rules: Complete (structural, formatting, content, technical) -⚠️ docs-linter ESM compatibility: Needs remark ESM module fix - ✅ Integration design: Ready for when linter is functional ## Next Steps 1. Fix remark ESM imports in docs-linter (convert to ESM or use compatible versions) 2. Add pre-commit hook to run docs-linter automatically 3. Test hybrid mode with both linter + AI review 4. Add CI/CD integration for automated checks Related to KM documentation standards initiative and PR #115
longieirl
added a commit
that referenced
this pull request
Mar 3, 2026
This commit establishes a hybrid documentation review system combining automated linting with AI-powered contextual analysis. - New skill at .claude/skills/km-review.md - Applies comprehensive KM standards to documentation files - Supports --fix flag for auto-fixes - Supports --score-only for quick quality checks - Supports --ai-only to skip linter (AI review only) - Integrates with docs-linter when available - Complete CLI implementation in docs-linter/src/cli.js - Commands: check, fix, validate - Color-coded output with severity levels - JSON output support for programmatic use - Dry-run mode for previewing fixes - Fixed remark processor initialization - Removed unnecessary remarkStringify dependency - Prepared for ESM/CommonJS compatibility The system provides two complementary review approaches: **Fast Automated Review (docs-linter)** - Rule-based checking using AST parsing - Instant feedback on objective violations - Safe auto-fixes for common issues - Pre-commit hook integration ready **Deep Contextual Review (/km-review)** - AI-powered analysis with full context - Understands intent and technical meaning - Explains why issues matter - Catches subjective quality issues /km-review misc/onpremise/README.md --score-only /km-review misc/onpremise/README.md /km-review misc/onpremise/README.md --fix node docs-linter/src/cli.js validate misc/onpremise/README.md - ✅ /km-review skill: Fully functional - ✅ docs-linter CLI: Implemented - ✅ docs-linter rules: Complete (structural, formatting, content, technical) -⚠️ docs-linter ESM compatibility: Needs remark ESM module fix - ✅ Integration design: Ready for when linter is functional 1. Fix remark ESM imports in docs-linter (convert to ESM or use compatible versions) 2. Add pre-commit hook to run docs-linter automatically 3. Test hybrid mode with both linter + AI review 4. Add CI/CD integration for automated checks Related to KM documentation standards initiative and PR #115
lfindlaysap
requested changes
Mar 6, 2026
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
lfindlaysap
requested changes
Mar 9, 2026
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
Co-authored-by: Louise Findlay <louise.findlay@sap.com>
- Convert all list markers from * to - (preferred marker rule) - Apply sentence case to H3+ headings (Cloud Connector configuration, SAP BTP destination, Deployment prerequisites, etc.) - Remove trailing question mark from "What this test validates" - Fix "is working" -> "works" (weak phrasing rule)
lfindlaysap
approved these changes
Mar 9, 2026
2 tasks
longieirl
added a commit
that referenced
this pull request
Mar 11, 2026
This commit establishes a hybrid documentation review system combining automated linting with AI-powered contextual analysis. - New skill at .claude/skills/km-review.md - Applies comprehensive KM standards to documentation files - Supports --fix flag for auto-fixes - Supports --score-only for quick quality checks - Supports --ai-only to skip linter (AI review only) - Integrates with docs-linter when available - Complete CLI implementation in docs-linter/src/cli.js - Commands: check, fix, validate - Color-coded output with severity levels - JSON output support for programmatic use - Dry-run mode for previewing fixes - Fixed remark processor initialization - Removed unnecessary remarkStringify dependency - Prepared for ESM/CommonJS compatibility The system provides two complementary review approaches: **Fast Automated Review (docs-linter)** - Rule-based checking using AST parsing - Instant feedback on objective violations - Safe auto-fixes for common issues - Pre-commit hook integration ready **Deep Contextual Review (/km-review)** - AI-powered analysis with full context - Understands intent and technical meaning - Explains why issues matter - Catches subjective quality issues /km-review misc/onpremise/README.md --score-only /km-review misc/onpremise/README.md /km-review misc/onpremise/README.md --fix node docs-linter/src/cli.js validate misc/onpremise/README.md - ✅ /km-review skill: Fully functional - ✅ docs-linter CLI: Implemented - ✅ docs-linter rules: Complete (structural, formatting, content, technical) -⚠️ docs-linter ESM compatibility: Needs remark ESM module fix - ✅ Integration design: Ready for when linter is functional 1. Fix remark ESM imports in docs-linter (convert to ESM or use compatible versions) 2. Add pre-commit hook to run docs-linter automatically 3. Test hybrid mode with both linter + AI review 4. Add CI/CD integration for automated checks Related to KM documentation standards initiative and PR #115
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
2 participants
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.
Apply KM Style Guide heading capitalization rules:
Changes:
Follows KM documentation standards per docs/km-style-guide.md
Pull Request
What does this PR do?
Checklist