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

Edit + explain id formatting #707

Merged
merged 2 commits into from
Dec 1, 2023
Merged

Edit + explain id formatting #707

merged 2 commits into from
Dec 1, 2023

Conversation

Erin-Cecele
Copy link
Collaborator

Thank you for contributing to the Quire Documentation & Website! Please complete the form below to submit your pull request for review.

For the Title of this pull request, please use the format "Type/Issue-#: Brief description." For Type, the options are Edit, Add, Translate. Issue-# is only needed if this pull request addresses an existing issue.

Checklist

Please put an X within the brackets that apply [X].

  • I have read the CONTRIBUTING.md file.

  • I have made my changes in a new branch and not directly in the main branch

  • I am requesting feedback on a draft pull request

Is this pull request related to an open issue? If so, what is the issue number?

Yes, this is related to thegetty/quire#869 as reported by @cbutcosk

Please describe the goal of this pull request and the changes that were made.

With the switch to 11ty, ids have become more sensitive. If they include periods, upper case letters, underscores, etc. they will cause the preview to break. The documentation has been updated to reflect this change.

I also took this as an opportunity to made additional edits/clarifications.

Additional Comments

Thank you @cbutcosk for reporting this inconsistency with the docs!

@Erin-Cecele Erin-Cecele requested a review from geealbers December 1, 2023 17:23
Copy link
Member

@geealbers geealbers left a comment

Choose a reason for hiding this comment

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

Looks good. Just need to remove the erroneous preceding slashes we had in there for the image src

content/docs-v1/figure-images.md Outdated Show resolved Hide resolved
content/docs-v1/figure-images.md Outdated Show resolved Hide resolved
content/docs-v1/figure-images.md Outdated Show resolved Hide resolved
@Erin-Cecele
Copy link
Collaborator Author

Thank you @geealbers. The change has been made

@Erin-Cecele Erin-Cecele merged commit 261168e into main Dec 1, 2023
@Erin-Cecele Erin-Cecele deleted the edit/update-figures-869 branch December 1, 2023 20:44
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