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

Improved readability and consistency #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

camlyall
Copy link
Member

@camlyall camlyall commented Apr 13, 2024

  • Removed link bracketing and italics
  • Tidied 'see more information' links
    • [see foo for more information](#foo). to See [foo](#foo).
    • Also offered alternative to end of line links with inline links.
      • we are talking about [foo](#foo) which is bar.
  • Removed dead links
  • Removed space before TM
  • Some capitalization, spelling and formatting
  • Changed 'General' header to 'CurateTM'
  • Added to Curate Mission Control section

  - Removed link bracketing and italics
  - Tidied 'see more information' links
    -`[see stuff for more information](#stuff)` to `See [stuff](#stuff)`
    - Also offered alternative to end of line links with inline links.
      - `we are talking about [stuff](#stuff) which is fun`
  - Removed dead links
  - Removed space before TM
  - Some capitalization, spelling and formatting
  - Changed 'General' header to 'CurateTM'
  - Added to Curate Mission Control section
@camlyall camlyall requested a review from Sunday-Crunk April 13, 2024 17:41
@camlyall
Copy link
Member Author

I couldn't decide between inline links or end of line links in some cases so in places where I've done this:

-verify that they have valid integrity checks [*see pre-upload integrity verification*](#pre-upload-integrity-verification).
+verify that they have [valid integrity checks](#pre-upload-integrity-verification). See [Pre-upload Integrity Verification](#pre-upload-integrity-verification).

"verify that they have valid integrity checks. See Pre-upload Integrity Verification."

I'm offering both for your suggestion.
I lead more towards inline though. Neater

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.

1 participant