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

Doc improvements #1558

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

Conversation

aellerton
Copy link

@aellerton aellerton commented Aug 23, 2024

  • some typos

  • some hyperlink fixes

  • reduction of 'So', 'But' etc at start of sentences, while hopefully keeping the same light tone.

  • "diagramme" - though I generally prefer international English spelling, in tech content I have come to see that the US spelling causes the least friction. For example, "colour" and "authorisation", which is how I would spell things personally, only add confusion vs "color" and "authorization". For that reason I changed "diagramme" to "diagram" for consistency.

  • some readability tweaks because I was there :)

EDIT: if you'd prefer I reduce this change to only typos and hyperlink fixes, that's no problem :)

Copy link

netlify bot commented Aug 23, 2024

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 5b71302
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/66c807489dce5d000833edee
😎 Deploy Preview https://deploy-preview-1558--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

- some typos

- some hyperlink fixes

- reduction of 'So', 'But' etc at start of sentences, while hopefully
  keeping the same light tone.

- "diagramme" - though I generally prefer international English spelling,
  in tech content I have come to see that the US spelling causes the
  least friction. For example, "colour" and "authorisation", which is
  how I would spell things personally, only add confusion vs "color" and
  "authorization". For that reason I changed "diagramme" to "diagram"
  for consistency.

- some readability tweaks because I was there :)
@KyleAMathews
Copy link
Contributor

Hey! Thanks for helping out. Yeah if you could remove the bigger edits that'd help. I'm the only American on the team so tread carefully haha on spelling cc @thruflo

@aellerton
Copy link
Author

aellerton commented Aug 26, 2024 via email

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.

3 participants