Rescaffolding docs incorrect note about parameters

[Sijoma]

What broke? What's expected?

The documentation for rescaffolding mentions two contradictory statements:

output-dir is the path to the directory where you want to generate the new project. Default is a subdirectory in the current working directory.

If neither input-dir nor output-dir are specified, the project will be regenerated in the current directory.

The note also mentions:

This approach facilitates comparison between your current local branch and the version stored upstream (e.g., GitHub main branch). This way, you can easily overlay your project’s code changes atop the new scaffold.

From the above defaults I expected the output-dir from the extra note was expecting something where I can easily diff the result with Git inside the same folders. Comparing with git is not really possible if its in a subfolder outputdir`.

Reproducing this issue

Run the kubebuilder alpha generate command and see that a output-dir is created.

KubeBuilder (CLI) Version

4.3.1

PROJECT version

3

Plugin versions

No response

Other versions

go 1.23.4

Extra Labels

/kind documentation

[camilamacedo86]

Hi @Sijoma,

I think what raised confusion here: 'Default is a subdirectory in the current working directory.`.
However, please feel free to open a PR with any improvement/suggestion that you see fit for the documentation.
Then, we move from there.

Thank you for looking into that.

[Sijoma]

I tried to improve it a little bit in this draft PR #4479 .

Maybe this helps.

[Sijoma]

/assign