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

Update to readme.md #93

Merged
merged 17 commits into from
Jun 22, 2022
Merged

Update to readme.md #93

merged 17 commits into from
Jun 22, 2022

Conversation

mackerac
Copy link
Contributor

@mackerac mackerac commented Jun 17, 2022

Description

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've updated the code style using make codestyle.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mackerac
Copy link
Contributor Author

Changes Requested completed

Copy link
Member

@alexcombessie alexcombessie left a comment

Choose a reason for hiding this comment

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

Small thing before merging

After each section, upload your model, collect feedback, etc., can you put a link to the relevant documentation section?
Ex: Upload your model -> https://docs.giskard.ai/start/guides/upload-your-model
For the style, you could for instance write "👉 Documentation" with a hyperlink.

@mackerac
Copy link
Contributor Author

Added documentation links

@alexcombessie
Copy link
Member

Good for me! @jmsquare can you review as well?

@mackerac
Copy link
Contributor Author

Changes suggested by JM added in the last commits.

@alexcombessie alexcombessie merged commit eff935d into Giskard-AI:main Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants