kraftkit icon indicating copy to clipboard operation
kraftkit copied to clipboard

fix(gendocs): Remove old link prefixes

Open craciunoiuc opened this issue 1 year ago • 1 comments

Prerequisite checklist

  • [ ] Read the contribution guidelines regarding submitting new changes to the project;
  • [ ] Tested your changes against relevant architectures and platforms;
  • [ ] Ran make fmt on your commit series before opening this PR;
  • [ ] Updated relevant documentation.

Description of changes

@nderjung this might not be universally correct, but keep it in mind when deploying docs. After an initial scan it looks fine.

craciunoiuc avatar Feb 09 '24 13:02 craciunoiuc

Can you please add a CLI arg that provides the user the option to specify the URL prefix? This allows the docs to be placed in different places whilst simultaneously preventing this type of fix in the future.

The flag should be named -url-prefix and should be propagated as a GNU Make variable, DOCS_URL_PREFIX, for the gendocs target. The default value should be set to /docs/cli/reference/.

nderjung avatar Feb 12 '24 17:02 nderjung