Skip to content

Fix documentation generation for examples with missing titles and update README#98

Merged
alexec merged 5 commits intomainfrom
copilot/fix-cfc13fbf-fabb-4543-a5ef-fb92bc539ea5
Sep 19, 2025
Merged

Fix documentation generation for examples with missing titles and update README#98
alexec merged 5 commits intomainfrom
copilot/fix-cfc13fbf-fabb-4543-a5ef-fb92bc539ea5

Conversation

Copy link
Contributor

Copilot AI commented Sep 19, 2025

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 createExamplesReadme function in hack/examples.go was directly using example.Title without checking if it was empty. When examples in docs/examples/examples.yaml didn't have a title field, this created broken links in the generated README.

Solution

  1. Fixed the documentation generation logic: Modified createExamplesReadme to use the name field as a fallback when title is empty, ensuring all links have proper text.

  2. Added missing titles: Added descriptive titles to all examples that were missing them:

    • Database examples: PostgreSQL, MySQL, MariaDB, Redis, MongoDB, Memcached, InfluxDB
    • Messaging examples: Apache Kafka, RabbitMQ, NATS, Apache Pulsar
    • Web server examples: Nginx, Apache HTTP Server
    • AWS examples: DynamoDB Local, Timestream (Moto)
    • Simulation: Sim
  3. Updated .gitignore: Added patterns to exclude log files that shouldn't be committed.

  4. Updated README: Enhanced the Web UI key feature description to highlight real-time metrics monitoring, reflecting recent improvements to the metrics system.

Before

 * [](postgres.md) The postgres container image provides...
 * [](kafka.md) 
 * [](sim.md)

After

 * [PostgreSQL](postgres.md) The postgres container image provides...
 * [Apache Kafka](kafka.md) Apache Kafka is a distributed streaming platform...
 * [Sim](sim.md) Sim is a straight-forward API simulation tool...

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.

Copilot AI and others added 2 commits September 19, 2025 04:34
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
Copilot AI requested a review from alexec September 19, 2025 04:38
Copy link
Collaborator

@alexec alexec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look at README.md and the recent commits and update the README.md

@coderabbitai

This comment was marked as outdated.

@alexec alexec closed this Sep 19, 2025
@alexec alexec reopened this Sep 19, 2025
@alexec
Copy link
Collaborator

alexec commented Sep 19, 2025

@copilot Look at README.md and the recent commits and update the README.md

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Sep 19, 2025

@copilot Look at README.md and the recent commits and update the README.md

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
Copilot AI requested a review from alexec September 19, 2025 14:58
@alexec alexec marked this pull request as ready for review September 19, 2025 16:23
@alexec alexec merged commit 477e0b1 into main Sep 19, 2025
3 checks passed
@alexec alexec deleted the copilot/fix-cfc13fbf-fabb-4543-a5ef-fb92bc539ea5 branch September 19, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants