[Feature] Commit-based Change History about ng-doc HOT 3 OPEN

@semicolin This ticket is more about displaying the history of changes for specific pages. For example, if a page is dedicated to a button and its functionality, theoretically, it could automatically generate and display the history of the button's recent changes. I believe such a feature could be convenient.

Regarding versioning and documentation for different versions of the library/project, I've considered this. It's not entirely NgDoc's responsibility, and I think the optimal solution would be to create and deploy multiple Angular applications.

For instance, let's say you have a library. If you maintain multiple versions, you'll likely have branches like 1.x.x, 2.x.x, and so on in your repository to facilitate bug fixes and updates for them. Correspondingly, you'll have pipelines for releasing the library and deploying its documentation.

In theory, in your pipeline, you could publish applications on specific routes using a script or any other method based on the major version. For example, my-doc.com/v1 could point to the application from the 1.x.x branch, and my-doc.com/v2 to the application from the 2.x.x branch. In the demo application itself, you could add something like a dropdown list to switch between versions. I think this solution is the simplest; it wouldn't require extensive support and should work with your server's standard routing.

Of course, there could also be an example involving micro-frontends, but I believe it would be more complex to implement and would require additional actions when new versions of the application are released. Therefore, I would prefer the option of having multiple applications on different routes.

from ng-doc.

If you have any thoughts about this feature please share!

from ng-doc.

My team does not use the Angular commit format, but I am interested in some kind of documentation history/versioning so users who are on an older version can see the documentation that matches their version.

from ng-doc.