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 Markdown indentation/lists for IIIF doc #2255

Merged
merged 2 commits into from
Aug 23, 2023

Conversation

bencomp
Copy link
Contributor

@bencomp bencomp commented Aug 21, 2023

Purpose / why

I noticed that the documentation page for IIIF had *s in running text, that looked like they should have been list items. When I started editing, I noticed some other grammar, spacing and style issues.

What changes were made?

  • separate list from running text with an empty line
  • indent nested lists with four spaces instead of three or two
  • use - for list items (instead of *)
  • remove unnecessary leading and trailing spaces
  • add or remove periods (.) for consistent lists
  • collapse three spaces to one in the middle of sentences
  • remove "Just" from "Just follow these instructions", as this may discourage readers
  • rewrite the sentence linking to the IIIF Awesome List to make it a full sentence
  • use HTTPS instead of HTTP in the Biblissima link

Verification

The Markdown was correctly interpreted in the VS Codium preview after my edits.

Interested Parties

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@rosiel rosiel merged commit 6bcac22 into Islandora:main Aug 23, 2023
1 check failed
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