Skip to content

docs(server): grammar and structure fixes#4904

Merged
Fdawgs merged 6 commits intomainfrom
docs/server
Jul 18, 2023
Merged

docs(server): grammar and structure fixes#4904
Fdawgs merged 6 commits intomainfrom
docs/server

Conversation

@Fdawgs
Copy link
Member

@Fdawgs Fdawgs commented Jul 14, 2023

  • Fixed grammar inconsistencies
  • Fixed use of British English, rewrote to use American English to be inline with rest of documentation
  • Fixed markdown issues (bolding, links etc.) that led to the text looked funny when viewing on fastify.dev
  • Fixed overuse of "Note" sections; worked them into the body of the text
  • Standardised remaining "Note" sections; some were bolded, some were quoted, so just threw all into quotes
  • Fixed inconsistent placement of default value (now nearly all towards the top of a section)

Checklist

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 14, 2023
@Fdawgs Fdawgs marked this pull request as ready for review July 14, 2023 20:57
Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

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

LGTM amazing work!

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@Fdawgs Fdawgs merged commit bf01ba4 into main Jul 18, 2023
@Fdawgs Fdawgs deleted the docs/server branch July 18, 2023 18:57
renovate bot referenced this pull request in tomacheese/telcheck Jul 27, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [fastify](https://www.fastify.io/)
([source](https://togithub.com/fastify/fastify)) | [`4.20.0` ->
`4.21.0`](https://renovatebot.com/diffs/npm/fastify/4.20.0/4.21.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/fastify/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/fastify/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/fastify/4.20.0/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/fastify/4.20.0/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>fastify/fastify (fastify)</summary>

###
[`v4.21.0`](https://togithub.com/fastify/fastify/releases/tag/v4.21.0)

[Compare
Source](https://togithub.com/fastify/fastify/compare/v4.20.0...v4.21.0)

#### What's Changed

- chore: remove license-checker package by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4914](https://togithub.com/fastify/fastify/pull/4914)
- chore: remove pump devDependency by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4913](https://togithub.com/fastify/fastify/pull/4913)
- ci: create artifacts in coverage workflows by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4909](https://togithub.com/fastify/fastify/pull/4909)
- docs(server): grammar and structure fixes by
[@&#8203;Fdawgs](https://togithub.com/Fdawgs) in
[https://github.com/fastify/fastify/pull/4904](https://togithub.com/fastify/fastify/pull/4904)
- docs: Fix typo in TypeScript docs
("[@&#8203;types/node](https://togithub.com/types/node)", not
"[@&#8203;node/types](https://togithub.com/node/types)") by
[@&#8203;jasongwartz](https://togithub.com/jasongwartz) in
[https://github.com/fastify/fastify/pull/4922](https://togithub.com/fastify/fastify/pull/4922)
- \[readme] add CII Best Practices Badge by
[@&#8203;ljharb](https://togithub.com/ljharb) in
[https://github.com/fastify/fastify/pull/4926](https://togithub.com/fastify/fastify/pull/4926)
- fix: lowercase type-providers headers types by
[@&#8203;toomuchdesign](https://togithub.com/toomuchdesign) in
[https://github.com/fastify/fastify/pull/4928](https://togithub.com/fastify/fastify/pull/4928)
- ERR_REP_ALREADY_SENT hint that a route may be missing "return reply"
by [@&#8203;mcollina](https://togithub.com/mcollina) in
[https://github.com/fastify/fastify/pull/4921](https://togithub.com/fastify/fastify/pull/4921)
- fix: ReplyTypeConstrainer array type inference by
[@&#8203;pedroescumalha](https://togithub.com/pedroescumalha) in
[https://github.com/fastify/fastify/pull/4885](https://togithub.com/fastify/fastify/pull/4885)

#### New Contributors

- [@&#8203;jasongwartz](https://togithub.com/jasongwartz) made their
first contribution in
[https://github.com/fastify/fastify/pull/4922](https://togithub.com/fastify/fastify/pull/4922)
- [@&#8203;ljharb](https://togithub.com/ljharb) made their first
contribution in
[https://github.com/fastify/fastify/pull/4926](https://togithub.com/fastify/fastify/pull/4926)
- [@&#8203;toomuchdesign](https://togithub.com/toomuchdesign) made their
first contribution in
[https://github.com/fastify/fastify/pull/4928](https://togithub.com/fastify/fastify/pull/4928)
- [@&#8203;pedroescumalha](https://togithub.com/pedroescumalha) made
their first contribution in
[https://github.com/fastify/fastify/pull/4885](https://togithub.com/fastify/fastify/pull/4885)

**Full Changelog**:
fastify/fastify@v4.20.0...v4.21.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/tomacheese/telcheck).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yNC4yIiwidXBkYXRlZEluVmVyIjoiMzYuMjQuMiIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot referenced this pull request in redwoodjs/graphql Aug 2, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [fastify](https://www.fastify.io/)
([source](https://togithub.com/fastify/fastify)) | [`4.20.0` ->
`4.21.0`](https://renovatebot.com/diffs/npm/fastify/4.20.0/4.21.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/fastify/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/fastify/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/fastify/4.20.0/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/fastify/4.20.0/4.21.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>fastify/fastify (fastify)</summary>

###
[`v4.21.0`](https://togithub.com/fastify/fastify/releases/tag/v4.21.0)

[Compare
Source](https://togithub.com/fastify/fastify/compare/v4.20.0...v4.21.0)

#### What's Changed

- chore: remove license-checker package by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4914](https://togithub.com/fastify/fastify/pull/4914)
- chore: remove pump devDependency by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4913](https://togithub.com/fastify/fastify/pull/4913)
- ci: create artifacts in coverage workflows by
[@&#8203;Uzlopak](https://togithub.com/Uzlopak) in
[https://github.com/fastify/fastify/pull/4909](https://togithub.com/fastify/fastify/pull/4909)
- docs(server): grammar and structure fixes by
[@&#8203;Fdawgs](https://togithub.com/Fdawgs) in
[https://github.com/fastify/fastify/pull/4904](https://togithub.com/fastify/fastify/pull/4904)
- docs: Fix typo in TypeScript docs
("[@&#8203;types/node](https://togithub.com/types/node)", not
"[@&#8203;node/types](https://togithub.com/node/types)") by
[@&#8203;jasongwartz](https://togithub.com/jasongwartz) in
[https://github.com/fastify/fastify/pull/4922](https://togithub.com/fastify/fastify/pull/4922)
- \[readme] add CII Best Practices Badge by
[@&#8203;ljharb](https://togithub.com/ljharb) in
[https://github.com/fastify/fastify/pull/4926](https://togithub.com/fastify/fastify/pull/4926)
- fix: lowercase type-providers headers types by
[@&#8203;toomuchdesign](https://togithub.com/toomuchdesign) in
[https://github.com/fastify/fastify/pull/4928](https://togithub.com/fastify/fastify/pull/4928)
- ERR_REP_ALREADY_SENT hint that a route may be missing "return reply"
by [@&#8203;mcollina](https://togithub.com/mcollina) in
[https://github.com/fastify/fastify/pull/4921](https://togithub.com/fastify/fastify/pull/4921)
- fix: ReplyTypeConstrainer array type inference by
[@&#8203;pedroescumalha](https://togithub.com/pedroescumalha) in
[https://github.com/fastify/fastify/pull/4885](https://togithub.com/fastify/fastify/pull/4885)

#### New Contributors

- [@&#8203;jasongwartz](https://togithub.com/jasongwartz) made their
first contribution in
[https://github.com/fastify/fastify/pull/4922](https://togithub.com/fastify/fastify/pull/4922)
- [@&#8203;ljharb](https://togithub.com/ljharb) made their first
contribution in
[https://github.com/fastify/fastify/pull/4926](https://togithub.com/fastify/fastify/pull/4926)
- [@&#8203;toomuchdesign](https://togithub.com/toomuchdesign) made their
first contribution in
[https://github.com/fastify/fastify/pull/4928](https://togithub.com/fastify/fastify/pull/4928)
- [@&#8203;pedroescumalha](https://togithub.com/pedroescumalha) made
their first contribution in
[https://github.com/fastify/fastify/pull/4885](https://togithub.com/fastify/fastify/pull/4885)

**Full Changelog**:
fastify/fastify@v4.20.0...v4.21.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/redwoodjs/redwood).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yNy4xIiwidXBkYXRlZEluVmVyIjoiMzYuMjcuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants