Skip to content

Consolidate and updatedocumentation with https://github.com/picoctf/start-problem-dev/ #4

@dbrumley

Description

@dbrumley
  • Consolidate the start-problem-dev with this repo, which has more examples and diagnostics like https://github.com/picoCTF/start-problem-dev/tree/master/common-errors

  • Include more information on the "why" for design here, and what is the minimum required. A few examples:

    • Most users shouldn't need to set Challenge Options, and the fact it's in all examples is confusing. People ask "how do I know what values to set here" when they typically shouldn't have to worry about it.
    • # PUBLISH 5555 AS socat is the most confusing. If we explain to people why that is there -- to hook up the problem creation template engine to the specific exposed port in a network setup -- it would help alot. (Indeed, this could be better designed all around, but the point is we tell people the spec but not why it's that way, leading to confusion)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions