Convert config documentation from Markdown to HTML #6
Conversation
FunToHard
commented
Sep 8, 2025
FunToHard
commented
- Replace config.md with config.html for better web presentation
- Add comprehensive configuration documentation with examples
- Include professional styling with responsive design
- Add interactive navigation and smooth scrolling
- Provide detailed explanations for all TranslucentTB settings
- Include troubleshooting section and best practices
- Replace config.md with config.html for better web presentation - Add comprehensive configuration documentation with examples - Include professional styling with responsive design - Add interactive navigation and smooth scrolling - Provide detailed explanations for all TranslucentTB settings - Include troubleshooting section and best practices
There was a problem hiding this comment.
Pull Request Overview
This PR converts the TranslucentTB configuration documentation from a placeholder Markdown file to a comprehensive HTML documentation page with professional styling and interactive features.
- Replaces the minimal config.md placeholder with a complete HTML documentation
- Adds comprehensive configuration documentation covering all TranslucentTB settings
- Includes interactive navigation, responsive design, and smooth scrolling functionality
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| config.md | Removes placeholder Markdown file with TODO note |
| config.html | Adds comprehensive HTML documentation with styling, navigation, and detailed configuration examples |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
config.html
Outdated
| <div class="config-card"> | ||
| <h4>Fully Transparent Desktop</h4> | ||
| <pre><code>{ | ||
| "$schema": "https://TranslucentTB.github.io/settings.schema.json", |
There was a problem hiding this comment.
[nitpick] Inconsistent casing in the schema URL. The domain uses 'TranslucentTB' with mixed case, which should likely be all lowercase 'translucenttb' to follow standard GitHub Pages conventions.
config.html
Outdated
| <div class="config-card"> | ||
| <h4>Application-Specific Rules</h4> | ||
| <pre><code>{ | ||
| "$schema": "https://TranslucentTB.github.io/settings.schema.json", |
There was a problem hiding this comment.
[nitpick] Inconsistent casing in the schema URL. The domain uses 'TranslucentTB' with mixed case, which should likely be all lowercase 'translucenttb' to follow standard GitHub Pages conventions.
config.html
Outdated
|
|
||
| <footer> | ||
| <div class="container"> | ||
| <p>© 2025 TranslucentTB Project. Configuration documentation for better Windows taskbar customization.</p> |
There was a problem hiding this comment.
[nitpick] The copyright year is 2025, but the current date context suggests this may be incorrect. Consider using the actual current year or a dynamic copyright year.
|
I would prefer if this stays markdown, to make it easier to maintain and fit in with the Jekyll theme we use to keep a consistent style. |
- Remove config.html and restore config.md. - Follow project consistency guidelines
FunToHard
force-pushed
the
feature/config-html-documentation
branch
from
0c5a05e to
678c9da
Compare
|
✅ Revert to Markdown format for consistency
All done as you mentioned. |
config.md
Outdated
|
|
||
| ### 6. Task View Opened Appearance | ||
|
|
||
| Applied when Task View (Alt+Tab) is open. |
config.md
Outdated
| - Example: `"#00000000"` (fully transparent black) | ||
|
|
||
| #### `show_peek` (boolean) | ||
| Enable/disable desktop peek functionality: |
There was a problem hiding this comment.
Hiding peek does not disable the functionality. This is classic taskbar only
| ### Common Issues | ||
|
|
||
| - **Configuration not loading**: Check JSON syntax and schema validation | ||
| - **Rules not working**: Verify process names and window classes using tools like Spy++ |
There was a problem hiding this comment.
AHK's window spy is more accessible to users
config.md
Outdated
| 1. **Check the logs**: Set `verbosity` to `"debug"` to see detailed information | ||
| 2. **Validate JSON**: Use online JSON validators or VS Code with the schema | ||
| 3. **Test incrementally**: Add one setting at a time to isolate issues | ||
| 4. **Use process monitor**: Tools like Process Monitor can help identify file access issues |
There was a problem hiding this comment.
This will not help the average user
|
give me two days. |
All done as requestedExceptions
|
2 participants
