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

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

Open
dbrumley opened this issue Nov 30, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dbrumley
Copy link

  • 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)
@dbrumley dbrumley added the documentation Improvements or additions to documentation label Nov 30, 2024
@dbrumley
Copy link
Author

Another example is the "seed" parameter. Unclear how it's used, and users just default to something like [1].

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

No branches or pull requests

2 participants