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

Documentation improvements #57

Closed
swashbuck opened this issue Jun 4, 2024 · 2 comments · Fixed by #58
Closed

Documentation improvements #57

swashbuck opened this issue Jun 4, 2024 · 2 comments · Fixed by #58
Assignees
Labels
enhancement New feature or request released

Comments

@swashbuck
Copy link
Contributor

swashbuck commented Jun 4, 2024

Subject of the enhancement

There are a few areas of the documentation that could be improved on. I'm still compiling a list, but here are a few:

_correct, incorrect, _partlyCorrect values

  1. When left blank, the branching sequence will go to the next available content block.
  2. Is @block+1 a valid value?

General

  1. How should the last block in a sequence be configured? Should it have values for _correct, incorrect, _partlyCorrect, should it have the _branching object but not other properties, etc?
  2. Can we have multiple branching articles on the same page?

Presentation components

  1. Are presentation components officially supported as part of the branching sequence? They are not specifically mentioned in the docs.
  2. What should the values of _correct, incorrect, _partlyCorrect be in presentation components? Empty strings, the same block ID, etc?

Miscellaneous housekeeping

  1. Remove "Framework versions" from README.md
  2. Fix typo in pull_request_template.md for "udpate"
@oliverfoster
Copy link
Member

oliverfoster commented Jun 4, 2024

Branching branches with blocks. Components don't have branching values. Block can contain any kind of component. Presentation component only blocks will complete when in view mostly. A block with only presentation components has only a _correct branch as it's impossible to get partly correct or incorrect.

@block+1 is valid only where there is a subsequent block. If assessment randomisation or banks and branching are used together then it's impossible to say which is the last block and therefore if there will be a subsequent block.

@swashbuck swashbuck self-assigned this Jun 4, 2024
@swashbuck swashbuck moved this from New to Assigned in adapt_framework: The TODO Board Jun 4, 2024
@swashbuck swashbuck moved this from Assigned to Needs Reviewing in adapt_framework: The TODO Board Jun 5, 2024
@swashbuck swashbuck moved this from Needs Reviewing to Assigned in adapt_framework: The TODO Board Jun 5, 2024
@swashbuck swashbuck moved this from Assigned to Needs Reviewing in adapt_framework: The TODO Board Jun 19, 2024
@github-project-automation github-project-automation bot moved this from Needs Reviewing to Recently Released in adapt_framework: The TODO Board Jun 21, 2024
github-actions bot pushed a commit that referenced this issue Jun 21, 2024
# [1.3.0](v1.2.3...v1.3.0) (2024-06-21)

### Update

* Documentation improvements (fixes #57) (#58) ([0e7036c](0e7036c)), closes [#57](#57) [#58](#58)
Copy link

🎉 This issue has been resolved in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants