Skip to content

Update reference to Diataxis framework and add alt-text #97

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

Merged
merged 3 commits into from
Aug 27, 2021

Conversation

maxrjones
Copy link

This PR adds alternative text to the image with Daniele Procinda's documentation system in content/tutorial-style-guide.md.

@isabela-pf isabela-pf mentioned this pull request Aug 12, 2021
8 tasks
Copy link
Collaborator

@rossbar rossbar left a comment

Choose a reason for hiding this comment

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

When looking at this I realized that there is a newer link to this material that we should probably be using instead: https://diataxis.fr/. This also gives a name to the documentation system, Diataxis framework, which will make it easier to refer to.

@maxrjones
Copy link
Author

When looking at this I realized that there is a newer link to this material that we should probably be using instead: https://diataxis.fr/. This also gives a name to the documentation system, Diataxis framework, which will make it easier to refer to.

OK, I can update accordingly but will not be able to do so right away.

@maxrjones
Copy link
Author

When looking at this I realized that there is a newer link to this material that we should probably be using instead: https://diataxis.fr/. This also gives a name to the documentation system, Diataxis framework, which will make it easier to refer to.

I updated the reference and figure link in the latest commit.

@maxrjones maxrjones changed the title Add alt-text to image in content/tutorial-style-guide.md Update reference to Diataxis framework and add alt-text Aug 26, 2021
Copy link
Collaborator

@rossbar rossbar left a comment

Choose a reason for hiding this comment

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

Thanks for this @meghanrjones - I took the liberty of slightly modifying the text to refer to the "Diataxis framework" by name rather than by author (attribution is maintained in the caption).

@rossbar rossbar merged commit 9876df5 into numpy:main Aug 27, 2021
@maxrjones maxrjones deleted the style-guide-alt branch August 30, 2021 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants