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

Fix broken links & text formatting in docs #302

Merged
merged 3 commits into from
Jan 10, 2022

Conversation

alex-zenml
Copy link
Contributor

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to the documentation, I have updated the documentation accordingly.
  • I have added tests to cover my changes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Describe changes

  • Fixed a bunch of broken links. (Note some these links will break again I think when we release a new version. We'll have to catch them then).
  • Fixed a bad formatting / markdown issue on the 'core concepts' page

@alex-zenml alex-zenml added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Jan 7, 2022
@alex-zenml alex-zenml requested review from htahir1 and bcdurak January 7, 2022 15:39
@alex-zenml
Copy link
Contributor Author

alex-zenml commented Jan 7, 2022

Also, note to self, we need a better way to check for these broken links in our documentation than just someone remembering to do it manually every few weeks :)

Copy link
Contributor

@AlexejPenner AlexejPenner left a comment

Choose a reason for hiding this comment

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

I hope this wasn't done manually for all 276 files ;)

@bcdurak
Copy link
Contributor

bcdurak commented Jan 10, 2022

276 files scared me at first :) everything looks good though

@alex-zenml
Copy link
Contributor Author

@bcdurak @AlexejPenner yes this touched every file with a license...

@alex-zenml alex-zenml merged commit 763cada into main Jan 10, 2022
@alex-zenml alex-zenml deleted the alex/core-concepts-docs-fixes branch January 10, 2022 16:02
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 internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants