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

docs: update the readme information DS-1066 #56

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Conversation

MaferMazu
Copy link
Contributor

@MaferMazu MaferMazu commented Jul 23, 2024

Description

This PR aims to simplify and be consistent with the readme.

  • Adds badges.
  • Improves the short description.
  • Lists the key features.
  • Improves the example explanation.
  • Adds license.

For a friendly reading: https://github.com/eduNEXT/eox-hooks/blob/mfmz/update-readme/README.rst

@MaferMazu MaferMazu changed the title docs: update the readme information docs: update the readme information DS-1066 Jul 23, 2024
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
docs/hooks_example.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
BryanttV
BryanttV previously approved these changes Jul 31, 2024
Copy link
Contributor

@BryanttV BryanttV left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

luisfelipec95
luisfelipec95 previously approved these changes Jul 31, 2024
@dcoa
Copy link

dcoa commented Jul 31, 2024

Sorry @MaferMazu do you mind updating the links inside the code that points to edx to openedx?

https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst

README.rst Outdated Show resolved Hide resolved
mariajgrimaldi
mariajgrimaldi previously approved these changes Jul 31, 2024
Copy link
Contributor

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

Thank you! I really like how we're moving documentation from the readme file to the /docs folder, making it easier to read by removing feature details.

@MaferMazu MaferMazu merged commit 2256d24 into master Aug 13, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants