-
Notifications
You must be signed in to change notification settings - Fork 0
Improve tooling and documentation #229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
af9c466
Rollback ansible-lint
bubacoder 06d5166
Fix path in repo-template script
bubacoder 11f94b6
Add flake8 config
bubacoder 0219362
Extend Claude Code permissions
bubacoder dd95b12
Add VSCode settings for GitHub Copilot and Spellright
bubacoder e626eae
Fix grammar and small issues in documentation
bubacoder c4a80ce
Upgrade Traefik to support Docker v29
bubacoder 0d1a282
Add agent command for improving documentation
bubacoder File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Improve Documentation | ||
|
|
||
| ## Variables | ||
|
|
||
| FILES: $ARGUMENTS | ||
|
|
||
| ## Instructions | ||
|
|
||
| Improve the spelling, grammar, and style of markdown-based documentation files in this repository. | ||
|
|
||
| ### Part 1 - Identify Documentation Files | ||
|
|
||
| 1. If FILES is provided, use those specific files. Otherwise, find all markdown files in the repository using: | ||
| - Search for files with `.md` extension | ||
| - Focus on documentation directories like `docs/`, `README.md`, and other markdown files | ||
| - Exclude generated files, third-party code, and non-documentation markdown | ||
|
|
||
| ### Part 2 - Analyze and Improve Each File | ||
|
|
||
| For each documentation file: | ||
|
|
||
| 1. **Read the file** to understand its content and purpose | ||
| 2. **Check for issues**: | ||
| - Spelling errors | ||
| - Grammar mistakes | ||
| - Inconsistent formatting | ||
| - Awkward phrasing or unclear sentences | ||
| - Missing or incorrect punctuation | ||
| - Inconsistent heading styles | ||
| - Broken links or references | ||
| 3. **Apply fixes**: | ||
| - Correct spelling errors | ||
| - Improve grammar and sentence structure | ||
| - Enhance clarity and readability | ||
| - Ensure consistent markdown formatting | ||
| - Fix any broken internal links | ||
| - Maintain the original meaning and technical accuracy | ||
|
|
||
| ### Part 3 - Quality Assurance | ||
|
|
||
| 1. After improving each file, re-read it to ensure: | ||
| - The content remains technically accurate | ||
| - The tone and style are appropriate for documentation | ||
| - Links and references still work | ||
| - Code examples (if any) are still valid | ||
| 2. Run any available linting tools on the modified files (e.g., markdownlint if configured) | ||
| 3. Verify that the changes don't break any documentation build processes | ||
|
|
||
| ### Part 4 - Summary | ||
|
|
||
| Provide a summary of all changes made, including: | ||
| - Files modified | ||
| - Types of improvements made (spelling, grammar, style) | ||
| - Any files that couldn't be improved and why | ||
|
|
||
| Notes: | ||
| - Preserve technical terminology and code snippets exactly as they are | ||
| - Maintain the existing documentation structure and organization | ||
| - Focus on clarity and professionalism while keeping the original voice | ||
| - If unsure about a technical term or concept, leave it unchanged | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [flake8] | ||
| extend-ignore = E501 # Line too long |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "github.copilot.enable": { | ||
| "properties": false | ||
| }, | ||
| "spellright.language": [ | ||
| "en" | ||
| ], | ||
| "spellright.documentTypes": [ | ||
| "markdown", | ||
| "latex", | ||
| "plaintext" | ||
| ] | ||
| } |
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
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
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
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
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
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.