I would propose to rename doc to <code class="notrans

The reason for the <a href="https://github.com/npryce/adr-tools/i

<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercon

Rename "doc" folder to "docs" about adr-j HOT 3 OPEN

adoble commented on August 16, 2024

Rename "doc" folder to "docs"

from adr-j.

adoble commented on August 16, 2024

The reason for the rejection was that it was not backward compatible. This doesn’t apply to adr-j as the directories used for the ADRs is stored in the adr.properties file (docPath). This means that users do not have to do anything with previously initialized projects.
I used doc originally to preserve the behavior of the original ADR tool. I think we have come a long way since then and this is no longer a requirement.
#13 could mean that if users really wanted to change from doc to docs in an existing project they could do so. Note, the config command is more complicated than I first thought as config changes imply making a lot of changes to existing projects. Not impossible, it's just that I have not got around to it.
I would prefer that we use in this repository the default. Changing to docs means a bit of fiddling around (a test for the config command?).
As we are now using semantic versioning , have to consider if this change is an "incompatible API change" . In which case I would prefer to wait until we have accrued enough changes (e.g. #4, #13 plus anything else that's wanted) to justify a 4.0.0 release. What do you think?