Upcoming Feature: Version History for dbdocs - Request Feedbacks

We’re thrilled to announce that we’re in the process of rolling out a new feature: Changelog (a.k.a Version History). This feature aims to enhance your experience by providing a detailed history of changes made to your documentation.

As we fine-tune the design and functionality, we would love to get your input to make sure it meets your needs and expectations.

How it works

:warning: Note that these functionalities and design is currently in design phase and could potentially be subjected to massive changes when being released officially.

(1) List all previous changes

You can list all historical builds of dbdocs and its related information

(2) Compare between two versions

You can see what changes between version by comparing the difference of DBML between these two versions.

(3) Name a version

To improve version readability, you can add name of the version while performing dbdocs build command in CLI or via GUI.

GUI

CLI

//  Example
dbdocs build --name "v1.2: Update new version"

(4) Share with others

You can copy and share the version with others by copying the url.

Here’s how you can help:

  1. :speech_balloon: Schedule a Chat: If you’d like to discuss this more in-depth, please book a time that suits you through our Calendar Booking Link. We’re looking forward to hearing more about your experiences and suggestions.
  2. Preview the Feature: We’ve attached some initial designs and mockups in this post. Take a look and imagine how you would use them in your workflow.
  3. Provide Feedback: Share your thoughts on the designs. What do you like? What could be improved? Do you think something crucial is missing?
  4. Discuss Use Cases: Tell us about how you might use the Changelog feature. Are there specific scenarios where it would be particularly helpful? How can it better serve your project management and documentation needs?

Your insights are crucial for us as we strive to make dbdocs more useful for everyone. Please drop your feedback, suggestions, and any questions you might have in the comments below.

Thank you for being an active part of our community. Your input not only helps improve dbdocs but also shapes its future.

Looking forward to your thoughts!