Skip to content

Fixed docs/safe-haven-services/s3-service.md formatting and broken link - #345

Open
mikej888 wants to merge 4 commits into
mainfrom
fix-shs-s3-service-link-formatting
Open

Fixed docs/safe-haven-services/s3-service.md formatting and broken link#345
mikej888 wants to merge 4 commits into
mainfrom
fix-shs-s3-service-link-formatting

Conversation

@mikej888

@mikej888 mikej888 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

EIDF Documentation Pull Request

Description

Fixed formatting to address 'pre-commit' check failures:

MD012 Multiple consecutive blank lines
MD028 Blank line inside blockquote
MD040 Fenced code blocks should have a language specified
MD031 Fenced code blocks should be surrounded by blank lines
MD032 Lists should be surrounded by blank lines

Replaced [NOTE] blocks with !!! Note blocks

Fixed broken link to docs/services/s3/ to be to docs/services/s3/index.md.

Myriad tweaks for readability and consistency.

Type of change

Please delete options that are not relevant.

  • Incorrect Documentation
  • Formatting

What has to be reviewed

docs/safe-haven-services/s3-service.md

Checklist

  • Documentation follows the project style guidelines
  • Self-review of documentation using mkdocs on local system
  • Spellcheck has been performed
  • Pre-commit has been run and passed

Fixed formatting to address 'pre-commit' check failures:

MD012 Multiple consecutive blank lines
MD028 Blank line inside blockquote
MD040 Fenced code blocks should have a language specified
MD031 Fenced code blocks should be surrounded by blank lines
MD032 Lists should be surrounded by blank lines

Replaced `[NOTE]` with `!!! Note` blocks
…/services/s3/

Link should be to docs/services/s3/index.md
@mikej888 mikej888 self-assigned this Sep 2, 2026
@mikej888 mikej888 added the documentation Improvements or additions to documentation label Sep 2, 2026
@mikej888
mikej888 requested a review from 2bPro September 2, 2026 14:45
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant