Conversation
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update the documentation.
Fix documentation generation for examples with missing titles
Sep 19, 2025
alexec
requested changes
Sep 19, 2025
Collaborator
alexec
left a comment
There was a problem hiding this comment.
Look at README.md and the recent commits and update the README.md
This comment was marked as outdated.
This comment was marked as outdated.
Collaborator
|
@copilot Look at README.md and the recent commits and update the README.md |
Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Contributor
Author
Updated the README to highlight that the Web UI includes real-time metrics monitoring, reflecting the recent improvements to the metrics system in commit bbf8b77. The Web UI key feature description now mentions "monitor task status with real-time metrics" to better reflect the current capabilities. |
Copilot
AI
changed the title
Fix documentation generation for examples with missing titles
Fix documentation generation for examples with missing titles and update README
Sep 19, 2025
alexec
approved these changes
Sep 19, 2025
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
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.
The documentation generation process was creating broken links in the examples README when example entries didn't have explicit titles defined. This resulted in malformed markdown links like
[](postgres.md)instead of proper descriptive links. Additionally, updated the main README to better reflect recent improvements.Problem
The
createExamplesReadmefunction inhack/examples.gowas directly usingexample.Titlewithout checking if it was empty. When examples indocs/examples/examples.yamldidn't have atitlefield, this created broken links in the generated README.Solution
Fixed the documentation generation logic: Modified
createExamplesReadmeto use thenamefield as a fallback whentitleis empty, ensuring all links have proper text.Added missing titles: Added descriptive titles to all examples that were missing them:
Updated .gitignore: Added patterns to exclude log files that shouldn't be committed.
Updated README: Enhanced the Web UI key feature description to highlight real-time metrics monitoring, reflecting recent improvements to the metrics system.
Before
After
All documentation has been regenerated and verified to have proper formatting and working links. The main README now better reflects the current capabilities of the Web UI including metrics monitoring.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.