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

[ENHANCEMENT] Developer Wiki #736

Closed
B-McCusker56 opened this issue Feb 15, 2024 · 0 comments
Closed

[ENHANCEMENT] Developer Wiki #736

B-McCusker56 opened this issue Feb 15, 2024 · 0 comments
Labels
documentation enhancement Improvement to existing feature

Comments

@B-McCusker56
Copy link
Collaborator

Describe the current behavior of what you're trying to improve. If your enhancement request related to a problem, please also describe the problem.

The guide for creating/developing a puzzle is quite comprehensive and a good starting point for new developers, however it lacks some key elements that will make getting a new puzzle running an easier process.

Describe the improvement you'd like

The creating a puzzle wiki page for developers needs an additional section for integrating the new puzzle into the exist LEGUP code base. Basically, additional information for adding a puzzle to the config files, location of config files, and formatting new puzzle files.

Describe alternatives you've considered

The alternative of course is having the developers trace back the errors caused by not adding a puzzle to the config file and resolve it themselves.

Additional Context

No response

@B-McCusker56 B-McCusker56 added the enhancement Improvement to existing feature label Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Improvement to existing feature
Projects
None yet
Development

No branches or pull requests

3 participants