Skip to content

Docs: add explanation question and configs #3974

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

Closed
wants to merge 26 commits into from

Conversation

stephanie0x00
Copy link
Contributor

Changes

This PR adds an explanation on what the Question and Config objects do, as this was currently missing from the docs.

Issue link

n/a.

Demo

n/a

QA notes

Double check if everything is correct and if no important bits are forgotten. :)


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00 stephanie0x00 requested a review from a team as a code owner December 17, 2024 13:32
@underdarknl underdarknl added the documentation Improvements or additions to documentation label Dec 25, 2024
@underdarknl underdarknl changed the title Docs add explanation question and configs Docs: add explanation question and configs Dec 25, 2024
Copy link
Contributor

@ammar92 ammar92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, looks good to me! However there seems to be more implementation changes than doc updates in this PR. Could it be that the branch was created from the wrong base or hasn't been updated recently?

@Donnype Donnype added this to KAT Mar 6, 2025
@github-project-automation github-project-automation bot moved this to Incoming features / Need assessment in KAT Mar 6, 2025
@Donnype Donnype moved this from Incoming features / Need assessment to Review in KAT Mar 6, 2025
@stephanie0x00
Copy link
Contributor Author

Can be closed as the current version of the docs is more descriptive than this PR.

@github-project-automation github-project-automation bot moved this from Review to Done in KAT Mar 19, 2025
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
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants