search

Ellerbach / docfx-companion-tools

A suite of tools, pipelines templates to take the very best of DocFX
MIT License
64 stars 18 forks source link

Renamed TocDocFxCreation to DocFxTocGenerator. Aligned namespaces #7

Closed mtirionMSFT closed 2 years ago

mtirionMSFT commented 2 years ago

Renamed the solution, namespaces and executable to better align with the naming scheme of the tools. I wanted to do this before publishing to Chocolatey later.

Ellerbach commented 2 years ago

That will brake quite some elements for people already using it. I'm struggling with the right way of handling this. Any idea? Maybe a simple project with the old name outputting a message that the name of the app has changed? And the new URL? Before merging and approving, that should be answered. Also, a PR will have to be done in the DocFx documentation to adjust the naming.

mtirionMSFT commented 2 years ago

@Ellerbach I thought about that, but ... most people have a copy of the tools and use it in their own environment (as we have described in the docs). The links still all work, just the executable name has changed. And I have changed the documentation in this PR as well. As we didn't have versioning before, we should start now. I've set the current main branch to v0.1.0. With the automation in place (next PR) I suggest to move to v1.0.0, which indicates a breaking change.

Ellerbach commented 2 years ago

The links still all work, just the executable name has changed. And I have changed the documentation in this PR as well.

The directory has been renamed, so it will break. OK, I guess only few uses directly (like in nanoFramework). I guess with versioning and chocolatey, it will be better. Agree with the versioning as well. So good to go!