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

Improve documentation #130

Open
ydahhrk opened this issue Apr 21, 2024 · 2 comments
Open

Improve documentation #130

ydahhrk opened this issue Apr 21, 2024 · 2 comments

Comments

@ydahhrk
Copy link
Member

ydahhrk commented Apr 21, 2024

https://nicmx.github.io/FORT-validator/index.html. (Also, the man page.)

It's awkward.

Honestly, I would love to rewrite the entire thing.

@owendelong
Copy link

In the rewrite process, I'd like to suggest a clear "Configuration" link and a shift from a focus on command-line arguments and how one can map those to config.json to instead having a focus on config.json and possibly describing how JSON elements can be expressed on the command line.

@ydahhrk
Copy link
Member Author

ydahhrk commented Oct 29, 2024

a shift from a focus on command-line arguments and how one can map those to config.json to instead having a focus on config.json and possibly describing how JSON elements can be expressed on the command line.

Was there something specific that gave you trouble when attempting to translate it?

Would individual examples have helped? eg. for server.port:

server.port

  • Type: String
  • Availability: argv and JSON
  • Default: "323"

TCP port or service the server address(es) will be bound to, if server.address doesn't override it.

JSON example:				CLI example:

{
	"mode": "server",		$ fort --mode=server \
	"server": {				--server.port=8123
		"port": "8123"
	}
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants