NICMx / FORT-validator

RPKI cache validator
MIT License
51 stars 24 forks source link

Improve documentation #130

Open ydahhrk opened 7 months ago

ydahhrk commented 7 months ago

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 commented 1 month ago

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 commented 1 month ago

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"
  }
}