Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove project-root and config-path from documentation #685

Merged
merged 2 commits into from
Feb 19, 2024

Conversation

lynnpepin
Copy link
Contributor

For issue #683, where --project-root and --config-path is described in documentation but doesn't work.

This changes the docs, not the code!

@shadows-withal
Copy link
Contributor

on second thought, I did some spelunking, and it seems that --project-root does absolutely nothing (I think it used to be a stop-gap solution for integration into something else), while --config-path works the way you'd expect, with the caveat that it still looks for an oranda-workspace.json in the current directory

I think we can remove mention of --project-root completely, but while I don't think we should un-hide --config-path from the actual CLI (yet), we can at least mention it on the page (with the caveat I mentioned). does that sound good?

@lynnpepin
Copy link
Contributor Author

Sure thing! I pushed a new change into my branch.

Removing --project-root left a one-item list on docs/src/cli/build.md, so I moved those details into the paragraph where --json-only is discussed. I couldn't decide if that or having a two-item list were better in build.md, e.g. I considered this as an alternative:

# `oranda build`

This command builds your oranda site. You can specify:

- The flag `--json-only`  in order for oranda to _only_ build an `artifacts.json` file that can be read by other tools
  (or websites) for integration purposes.
- The config path `--config-path` if your configuration file is not `./oranda.json`, but oranda will still look for an
  `oranda-workspace.json` in the current directory.
  

@shadows-withal shadows-withal merged commit 5c30d20 into axodotdev:main Feb 19, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants