apluslms / a-plus-rst-tools

Tools to publish RST course content for mooc-grader and a-plus. Should be cloned as a course submodule.

MIT License

6 stars 24 forks source link

README modifications for interactive code blocks (thebe) #138

Closed yusein-ali closed 2 years ago

yusein-ali commented 2 years ago

Description

What?

README file modified to describe interactive code blocks better.

Why?

The readme section needed improvement after adding new configurations.

How?

[ANSWER HERE]

Fixes #

Testing

Remember to add or update unit tests for new features and changes.

How to test your changes in A-plus
How to test accessibility

What type of test did you run?

[ ] Accessibility test using the WAVE extension.
[ ] Django unit tests.
[ ] Selenium tests.
[ ] Other test. (Add a description below)
[ X] Manual testing.

[ADD A DESCRIPTION ABOUT WHAT YOU TESTED MANUALLY]

Did you test the changes in

[ ] Chrome
[ ] Firefox
[ ] This pull request cannot be tested in the browser.

Not needed. Think of what is affected by these changes and could become broken

Translation

[ ] Did you modify or add new strings in the user interface? (Read about how to create translation)

Programming style

[ ] Did you follow our style guides?

Have you updated the README or other relevant documentation?

[ ] documents inside the doc directory.
[X ] README.md.
[ ] Aplus Manual.
[ ] Other documentation (mention below which documentation).

Is it Done?

[ ] Reviewer has finished the code review
[ ] After the review, the developer has made changes accordingly
[ ] Customer/Teacher has accepted the implementation of the feature

Clean up your git commit history before submitting the pull request!